javascript/pinyin-pro
1
0
Fork 0
mirror of https://github.com/zh-lx/pinyin-pro.git synced 2026-03-13 09:51:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(docs): 修改readme

Browse Source
This commit is contained in:
zh-lx
2021-01-23 17:53:50 +08:00
parent ea34b93492
commit 87f24d30c2
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -96,12 +96,12 @@ pinyin('好', { multiple: true, type: 'array' }); // ["hǎo", "hào"]
## options 配置
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| -------- | --------------------------------------------------- | ------- | ------------------------------ | ------ |
| pattern | 输出的结果的信息（带音调全拼 / 声母 / 韵母 / 音调） | string | pinyin / initial / final / num | pinyin |
| tone | 音调输出形式(拼音符号 / 数字 / 不加音调) | string | symbol / num / none | symbol |
| type | 输出结果类型（字符串/数组） | string | string / array | string |
| multiple | 输出多音字全部拼音（仅在 word 为单字时生效） | boolean | true / false | false |
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| -------- | ------------------------------------------------------------- | ------- | ------------------------------ | ------ |
| pattern | 输出的结果的信息（拼音 / 声母 / 韵母 / 音调） | string | pinyin / initial / final / num | pinyin |
| tone | 音调输出形式(拼音符号 / 数字 / 不加音调) | string | symbol / num / none | symbol |
| type | 输出结果类型（字符串/数组） | string | string / array | string |
| multiple | 输出多音字全部拼音（仅在 word 为长度为 1 的汉字字符串时生效） | boolean | true / false | false |
## 交流与反馈

12
docs/2.0.0.md
View File

@@ -92,12 +92,12 @@ pinyin('好', { multiple: true, type: 'array' }); // ["hǎo", "hào"]
## options 配置
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| -------- | --------------------------------------------------- | ------- | ------------------------------ | ------ |
| pattern | 输出的结果的信息（带音调全拼 / 声母 / 韵母 / 音调） | string | pinyin / initial / final / num | pinyin |
| tone | 音调输出形式(拼音符号 / 数字 / 不加音调) | string | symbol / num / none | symbol |
| type | 输出结果类型（字符串/数组） | string | string / array | string |
| multiple | 输出多音字全部拼音（仅在 word 为单字时生效） | boolean | true / false | false |
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| -------- | ------------------------------------------------------------- | ------- | ------------------------------ | ------ |
| pattern | 输出的结果的信息（拼音 / 声母 / 韵母 / 音调） | string | pinyin / initial / final / num | pinyin |
| tone | 音调输出形式(拼音符号 / 数字 / 不加音调) | string | symbol / num / none | symbol |
| type | 输出结果类型（字符串/数组） | string | string / array | string |
| multiple | 输出多音字全部拼音（仅在 word 为长度为 1 的汉字字符串时生效） | boolean | true / false | false |
## 交流与反馈