JSPM

fast-pinyin

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q36553F
  • License MIT

汉字转拼音函数

Package Exports

  • fast-pinyin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fast-pinyin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fast-pinyin

快速汉字转拼音库

特性

  • 仅支持 Node.js 环境。
  • pinyinpinyinlite 更快、更小、更节约内存。
  • 完整字库,支持所有简繁汉字。
  • 支持多音字,但不支持智能识别。
  • 支持音调。
  • 支持特殊字符。
  • 没有任何依赖项。

用法

npm install fast-pinyin
var pinyin = require("fast-pinyin");
var output = pinyin('增长1%'); // => [ 'zeng', 'chang', undefined, undefined ]

支持特殊字符

var output = pinyin('增长1%', {
    keepUnrecognized: true
}); // => [ 'zeng', 'chang', '1', '%' ]

支持多音字

var output = pinyin('增长1%', {
    heteronym: true
}); // => [ 'zeng', 'chang|zhang', undefined, undefined ]

支持音调

var output = pinyin('增长1%', {
    tone: true
}); // => [ 'zēng', 'cháng', undefined, undefined ]

提示,如果需要后期处理音调,可参考此库

组合所有选项

var output = pinyin('增长1%', {
    keepUnrecognized: true,
    heteronym: true,
    tone: true
}); // => [ 'zēng', 'cháng|zhǎng', '1', '%' ]

API

pinyin(value[, options])

获取汉字的拼音。

参数

value

String,要获取的汉字。

options(可选)

Object,解析的选项。

  • keepUnrecognized(可选): Boolean,是否包含未识别的字符。默认为 false。
  • heteronym(可选): Boolean,是否识别多音字。默认为 false。
  • tone(可选): Boolean,是否包含音调。默认为 false。

返回

String[],返回每个字符拼音字符串组成的数组,多音字用 | 分隔。如 "jī|kē"

原理

通过查询内置的拼音字典,检索每个汉字对应的拼音。 为减少字典体积,所有数据使用二进制存储,每次检索的时间复杂度为 O(1)

协议

MIT