np

node-pinyin

汉字拼音转换工具

Showing:

Popularity

Downloads/wk

135

GitHub Stars

35

Maintenance

Last Commit

6yrs ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

1.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

汉字拼音转换工具

npm npm Travis

本工具fork自https://github.com/hotoo/pinyin,原库以MIT协议开源,本库也以MIT协议开源。

功能

将汉字转为拼音,支持多音字。

安装

via npm:

npm install node-pinyin

用法

var pinyin = require("node-pinyin");

console.log(pinyin("重心"));    // [ [ 'zhòng' ], [ 'xīn' ] ]
console.log(pinyin("重心", {
  heteronym: true               // 启用多音字模式
}));                            // [ [ 'zhòng', 'chóng' ], [ 'xīn' ] ]

命令行:

$ pinyin 重心
zhòng xīn
$ pinyin -h

API

方法 <Array> pinyin(words[, options])

将传入的中文字符串(words)转换成拼音符号串。

options 是可选的,打开多音字选项和设定返回风格。

返回二维数组,第一维每个数组项位置对应每个中文字符串位置。 第二维是各个汉字的读音列表,多音字会有多个拼音项。

参数 <Boolean> options.heteronym

是否启用多音字模式,默认关闭。

关闭多音字模式时,返回每个汉字第一个匹配的拼音。

启用多音字模式时,返回多音字的所有拼音列表。

参数 <String> options.style

指定拼音 风格。可以通过以下几种属性值进行指定。

normal

普通风格,即不带音标。

如:pin yin

tone

声调风格,拼音声调在韵母第一个字母上。

注:这是默认的风格。

如:pīn yīn

toneWithNumber

声调风格,即拼音声调在各个拼音之后,用数字 [0-4] 进行表示。

如:pin1 yin1

initials

声母风格,只返回各个拼音的声母部分。

如:中国 的拼音 zh g

例外,对于只有韵母的汉字(如『爱、啊』等),会先转成不带音标的普通风格。

firstLetter

首字母风格,只返回拼音的首字母部分。

如:p y

Test

npm test

性能

源库由于启用了分词和词组匹配,导致内存占用极大,运算时间长,本库做了精简。

/benchmark下可运行性能测试脚本,以short.js为例,在MacbookPro(2.5 GHz Intel Core i5 / 8 GB 1600 MHz DDR3)上:

源库输出

pinyin: 1076ms
146112512

本库输出

# 0.2.0
pinyin: 12ms
1150976

# 0.1.0
pinyin: 131ms
31199232
项目源库本库百分比
运算时间1076ms12ms1.11%
内存占用139.3M1.1M0.79%

Q&A

本库与fork源库有哪些差异

  • 源库支持同时支持在Node和浏览器端,本库只考虑Node环境
  • 源库支持基于词组的精确转换,如重心中的,不会得到chong这个读音,本库去掉了这个特性
  • 源库支持简单的简繁转换,本库不支持
  • 源库内存占用大,运算时间长,本库内存和运算时间均有大幅优化

更新日志

v0.2.3 (2016-04-05)

  • 修复极端情况下无法读取到拼音的bug(“脑”)

v0.2.2 (2015-04-28)

  • 修复极端情况下无法读取到拼音的bug(“昊”)

v0.2.1 (2015-01-23)

  • 调整“的”的拼音,优先返回“de”

v0.2.0 (2015-01-21)

  • 更新数据存储和读取机制,大幅减少运算时间(12ms)和内存占用(1.1M)
  • 恢复代码风格选项

v0.1.0 (2014-12-17)

  • Fork初始发布
  • 大幅减少运算时间(131ms)和内存占用(29.7M)
  • 去掉源库分词特性
  • 去掉词语库
  • 去掉代码风格选项

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial