pinyin-pro - npm Package Compare versions

Comparing version 3.10.1 to 3.10.2

CHANGELOG.md

@@ -0,1 +1,10 @@
+## 3.10.2
+当前版本： 3.10.1 -> 3.10.2
+
+- 修正部分读音:
+  - 责: 'zhài' -> 'zé zhài'
+  - 朝阳: 'zhāo cháo yáng' -> 'cháo yáng'
+  - 假发: 'jiǎ fā' -> 'jiǎ fà'
+- 优化 typescript 的 `options` 中的配置项提示
+
 ## 3.10.1
@@ -2,0 +11,0 @@ 当前版本： 3.10.0 -> 3.10.1

lib/pinyin.ts

@@ -14,8 +14,48 @@ import {
 interface BasicOptions {
+  /**
+   * @description 返回的拼音音调类型
+   * @value symbol：在字母上加音调 （默认值）
+   * @value num：以数字格式展示音调，并跟在拼音后面
+   * @value none：不展示音调
+   */
   toneType?: 'symbol' | 'num' | 'none';
+  /**
+   * @description 返回的拼音格式类型
+   * @value pinyin：返回完整拼音 （默认值）
+   * @value initial：返回声母
+   * @value final：返回韵母
+   * @value num：返回音调对应的数字
+   * @value first：返回首字母
+   */
   pattern?: 'pinyin' | 'initial' | 'final' | 'num' | 'first';
+  /**
+   * @description 是否返回单个汉字的所有多音，仅针对输入的 word 为单个汉字生效
+   * @value false：返回最常用的一个拼音 （默认值）
+   * @value true：返回所有读音
+   */
   multiple?: boolean;
+  /**
+   * @description 优先的拼音匹配模式
+   * @value normal：正常匹配模式 （默认值）
+   * @value surname：姓氏模式，遇到姓氏表中的汉字时，优先匹配姓氏读音
+   */
   mode?: 'normal' | 'surname';
+  /**
+   * @description 是否移除非汉字字符（推荐使用 removeNonZh: removed 代替）
+   * @value false：返回结果保留非汉字字符 （默认值）
+   * @value true：返回结果移除非汉字字符
+   */
   removeNonZh?: boolean;
+  /**
+   * @description 非汉字字符的间距格式
+   * @value spaced：连续非汉字字符之间用空格隔开 （默认值）
+   * @value consecutive：连续非汉字字符无间距
+   * @value removed：返回结果移除非汉字字符
+   */
   nonZh?: 'spaced' | 'consecutive' | 'removed';
+  /**
+   * @description 对于 ü 的返回是否转换成 v（仅在 toneType: none 启用时生效）
+   * @value false：返回值中保留 ü （默认值）
+   * @value true：返回值中 ü 转换成 v
+   */
   v?: boolean;
@@ -25,2 +65,7 @@ }
 interface OptionsReturnString extends BasicOptions {
+  /**
+   * @description 返回结果的格式
+   * @value string：以字符串格式返回，拼音之间用空格隔开 （默认值）
+   * @value array：以数组格式返回
+   */
   type?: 'string';
@@ -30,5 +75,15 @@ }
 interface OptionsReturnArray extends BasicOptions {
+  /**
+   * @description 返回结果的格式
+   * @value string：以字符串格式返回，拼音之间用空格隔开 （默认值）
+   * @value array：以数组格式返回
+   */
   type: 'array';
 }
 interface CompleteOptions extends BasicOptions {
+  /**
+   * @description 返回结果的格式
+   * @value string：以字符串格式返回，拼音之间用空格隔开 （默认值）
+   * @value array：以数组格式返回
+   */
   type?: 'string' | 'array';
@@ -35,0 +90,0 @@ }

package.json

 {
   "name": "pinyin-pro",
-  "version": "3.10.1",
+  "version": "3.10.2",
   "description": "汉字转拼音库。获取中文拼音、韵母、声母、声调、首字母，支持拼音匹配",
@@ -5,0 +5,0 @@ "main": "./dist/index.cjs.js",

README.md

@@ -26,6 +26,9 @@ [![pinyin-pro Logo](https://i.ibb.co/26fJ5vF/pinyin-logo.png)](https://github.com/zh-lx/pinyin-pro)
 
-当前版本： 3.10.0 -> 3.10.1
+当前版本： 3.10.1 -> 3.10.2
 
-- 修正汉字拼音
-  - 哼：'hng' -> 'hēng hng'
+- 修正部分读音:
+  - 责: 'zhài' -> 'zé zhài'
+  - 朝阳: 'zhāo cháo yáng' -> 'cháo yáng'
+  - 假发: 'jiǎ fā' -> 'jiǎ fà'
+- 优化 typescript 的 `options` 中的配置项提示
 
@@ -32,0 +35,0 @@ 点击查看 [版本更新文档](./CHANGELOG.md)

types/lib/pinyin.d.ts

 interface BasicOptions {
+    /**
+     * @description 返回的拼音音调类型
+     * @value symbol：在字母上加音调 （默认值）
+     * @value num：以数字格式展示音调，并跟在拼音后面
+     * @value none：不展示音调
+     */
     toneType?: 'symbol' | 'num' | 'none';
+    /**
+     * @description 返回的拼音格式类型
+     * @value pinyin：返回完整拼音 （默认值）
+     * @value initial：返回声母
+     * @value final：返回韵母
+     * @value num：返回音调对应的数字
+     * @value first：返回首字母
+     */
     pattern?: 'pinyin' | 'initial' | 'final' | 'num' | 'first';
+    /**
+     * @description 是否返回单个汉字的所有多音，仅针对输入的 word 为单个汉字生效
+     * @value false：返回最常用的一个拼音 （默认值）
+     * @value true：返回所有读音
+     */
     multiple?: boolean;
+    /**
+     * @description 优先的拼音匹配模式
+     * @value normal：正常匹配模式 （默认值）
+     * @value surname：姓氏模式，遇到姓氏表中的汉字时，优先匹配姓氏读音
+     */
     mode?: 'normal' | 'surname';
+    /**
+     * @description 是否移除非汉字字符（推荐使用 removeNonZh: removed 代替）
+     * @value false：返回结果保留非汉字字符 （默认值）
+     * @value true：返回结果移除非汉字字符
+     */
     removeNonZh?: boolean;
+    /**
+     * @description 非汉字字符的间距格式
+     * @value spaced：连续非汉字字符之间用空格隔开 （默认值）
+     * @value consecutive：连续非汉字字符无间距
+     * @value removed：返回结果移除非汉字字符
+     */
     nonZh?: 'spaced' | 'consecutive' | 'removed';
+    /**
+     * @description 对于 ü 的返回是否转换成 v（仅在 toneType: none 启用时生效）
+     * @value false：返回值中保留 ü （默认值）
+     * @value true：返回值中 ü 转换成 v
+     */
     v?: boolean;
 }
 interface OptionsReturnString extends BasicOptions {
+    /**
+     * @description 返回结果的格式
+     * @value string：以字符串格式返回，拼音之间用空格隔开 （默认值）
+     * @value array：以数组格式返回
+     */
     type?: 'string';
 }
 interface OptionsReturnArray extends BasicOptions {
+    /**
+     * @description 返回结果的格式
+     * @value string：以字符串格式返回，拼音之间用空格隔开 （默认值）
+     * @value array：以数组格式返回
+     */
     type: 'array';
@@ -15,0 +65,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1574213

increased by0.31%

Lines of code

36930

increased by0.29%

Number of lines in readme file

292

increased by1.04%

No dependency changes