js获取汉字拼音

pinyin-pro实现javascript获取汉字拼音

特色功能

• 支持汉字、词语、句子多种格式输入获取
• 获取拼音
• 获取声母
• 获取韵母
• 获取拼音首字母
• 获取音调
• 获取多音字的多种拼音
• 支持字符串和数组两种输出形式

版本更新

当前版本： 3.0.7 -> 3.1.0

• 增加获取拼音首字母功能
• 修复 readme 中音调形式参数 toneType 错写成了 tone 的错误

点击查看 版本更新文档

安装

npm 安装

npm install pinyin-pro

yarn 安装

yarn add pinyin-pro

引入

ES6 引入：

import {
    pinyin } from 'pinyin-pro';

commonjs 引入：

const {
    pinyin } = require('pinyin-pro');

参数

pinyin(word, options) 接收两个参数

• word：必填。String 类型，需要转化为拼音的中文
• options：可选。Object 类型，用于配置各种输出形式，options 的键值配置如下：

参数	说明	类型	可选值	默认值
pattern	输出的结果的信息（拼音 / 声母 / 韵母 / 音调 / 首字母）	string	pinyin / initial / final / num / first	pinyin
toneType	音调输出形式(拼音符号 / 数字 / 不加音调)	string	symbol / num / none	symbol
type	输出结果类型（字符串/数组）	string	string / array	string
multiple	输出多音字全部拼音（仅在 word 为长度为 1 的汉字字符串时生效）	boolean	true / false	false

使用示例

获取拼音

// 获取带音调拼音
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
// 获取不带声调的拼音
pinyin('汉语拼音', {
    toneType: 'none' }); // 'han yu pin yin'
// 获取声调转换为数字后缀的拼音
pinyin('汉语拼音', {
    toneType: 'num' }