diff --git a/README.md b/README.md index c124263..7e0b76c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ pinyin-pro —— 专业的汉字拼音转换工具 [![GITHUB star](https://img.shields.io/github/stars/zh-lx/pinyin-pro.svg)](https://github.com/zh-lx/pinyin-pro) [![travis-build](https://travis-ci.com/zh-lx/pinyin-pro.svg?branch=main)](https://travis-ci.com/github/zh-lx/pinyin-pro) [![NPM Downloads](https://img.shields.io/npm/dm/pinyin-pro.svg)](https://npmcharts.com/compare/pinyin-pro?minimal=true) -[![MIT-license](https://img.shields.io/npm/l/pinyin-pro.svg)](https://opensource.org/licenses/MIT) +[![Coverage Status](https://coveralls.io/repos/github/zh-lx/pinyin-pro/badge.svg?branch=main)](https://coveralls.io/github/zh-lx/pinyin-pro?branch=main) ## 特色功能 @@ -21,7 +21,7 @@ pinyin-pro —— 专业的汉字拼音转换工具 当前版本: 3.0.1 -> 3.0.2 -- 优化了 npm 包质量 +- 优化了 npm 包质量和 readme 点击查看 [版本更新文档](./docs/versions.md) diff --git a/docs/3.0.2.md b/docs/3.0.2.md new file mode 100644 index 0000000..eb55c66 --- /dev/null +++ b/docs/3.0.2.md @@ -0,0 +1,122 @@ +[![pinyin-pro Logo](https://i.ibb.co/26fJ5vF/pinyin-logo.png)](https://github.com/zh-lx/pinyin-pro) + +pinyin-pro —— 专业的汉字拼音转换工具 + +[![NPM version](https://img.shields.io/npm/v/pinyin-pro.svg)](https://www.npmjs.com/package/pinyin-pro) +[![GITHUB star](https://img.shields.io/github/stars/zh-lx/pinyin-pro.svg)](https://github.com/zh-lx/pinyin-pro) +[![travis-build](https://travis-ci.com/zh-lx/pinyin-pro.svg?branch=main)](https://travis-ci.com/github/zh-lx/pinyin-pro) +[![NPM Downloads](https://img.shields.io/npm/dm/pinyin-pro.svg)](https://npmcharts.com/compare/pinyin-pro?minimal=true) +[![Coverage Status](https://coveralls.io/repos/github/zh-lx/pinyin-pro/badge.svg?branch=main)](https://coveralls.io/github/zh-lx/pinyin-pro?branch=main) + +## 特色功能 + +- 支持汉字、词语、句子等多种格式的拼音、声母、韵母、音调等多种转换形式 +- 支持多音字,词语句子智能获取读音 +- 支持繁体字和简体字 +- 支持字符串和数组两种输出格式 +- 通过高效的算法,有效加快查找速度 +- 对包体积进行了优化,保证识别准确的同时体积轻便 + +## 安装 + +npm 安装 + +``` +npm install pinyin-pro +``` + +yarn 安装 + +``` +yarn add pinyin-pro +``` + +## 引入 + +浏览器端: + +```javascript +import { pinyin } from 'pinyin-pro'; +``` + +node 端: + +```javascript +const { pinyin } = require('pinyin-pro'); +``` + +## 参数 + +`pinyin(word, options)` 接收两个参数
+ +- word:必填。String 类型,需要转化为拼音的中文 +- options:可选。Object 类型,用于配置各种输出形式,options 的键值配置如下: + +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +| -------- | ------------------------------------------------------------- | ------- | ------------------------------ | ------ | +| 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 | + +## 使用 + +### 基本用法 + +```javascript +import { pinyin } from 'pinyin-pro'; // 若为node环境请用require形式引入 + +// 获取带音调拼音 +pinyin('汉语拼音'); // 'hàn yǔ pīn yīn' +// 获取不带声调的拼音 +pinyin('汉语拼音', { toneType: 'none' }); // 'han yu pin yin' +// 获取声调转换为数字后缀的拼音 +pinyin('汉语拼音', { toneType: 'num' }); // 'han4 yu3 pin1 yin1' +// 获取声母 +pinyin('汉语拼音', { pattern: 'initial' }); // 'h y p y' +// 获取带音调韵母 +pinyin('汉语拼音', { pattern: 'final' }); // 'àn ǔ īn īn' +// 获取不带音调韵母 +pinyin('汉语拼音', { pattern: 'final', toneType: 'none' }); // 'an u in in' +// 获取音调为数字的韵母 +pinyin('汉语拼音', { pattern: 'final', toneType: 'num' }); // 'an4 u3 in1 in1' +// 获取音调 +pinyin('汉语拼音', { pattern: 'num' }); // '4 3 1 1' +``` + +### 结果输出为数组格式 + +通过在 options 参数中加入`type: 'array'`,可以以数组形式输出基本用法中的示例: + +```javascript +// 获取带音调拼音 +pinyin('汉语拼音', { type: 'array' }); // ["hàn", "yǔ", "pīn", "yīn"] +// 获取不带声调的拼音 +pinyin('汉语拼音', { toneType: 'none', type: 'array' }); // ["han", "yu", "pin", "yin"] +// 获取声调转换为数字后缀的拼音 +pinyin('汉语拼音', { toneType: 'num', type: 'array' }); // ["han4", "yu3", "pin1", "yin1"] +// 获取声母 +pinyin('汉语拼音', { pattern: 'initial', type: 'array' }); // ["h", "y", "p", "y"] +// 获取带音调韵母 +pinyin('汉语拼音', { pattern: 'final', type: 'array' }); // ["àn", "ǔ", "īn", "īn"] +// 获取不带音调韵母 +pinyin('汉语拼音', { pattern: 'final', toneType: 'none', type: 'array' }); // ["an", "u", "in", "in"] +// 获取音调 +pinyin('汉语拼音', { pattern: 'num', type: 'array' }); // ["4", "3", "1", "1"] +``` + +### 获取单个字的多音 + +只有单字可以获取到多音模式, 词语、句子无效。同样可以通过配置 options 选项获取数组形式、韵母等格式 + +```javascript +pinyin('好', { multiple: true }); // 'hǎo hào' +pinyin('好', { multiple: true, type: 'array' }); // ["hǎo", "hào"] +``` + +## 贡献与反馈 + +使用遇到问题或者需要功能支持欢迎提 issue。 + +交流及参与贡献欢迎加微信: +zhoulx1688888 diff --git a/docs/versions.md b/docs/versions.md index 1855122..036208e 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -1,3 +1,9 @@ +## 3.0.2 + +[version3.0.2](./3.0.2.md)] + +- 优化 npm 包质量和 readme + ## 3.0.1 [version3.0.1](./3.0.1.md)]