Fetching contributors…
Cannot retrieve contributors at this time
215 lines (132 sloc) 5.05 KB

pinyin for Han (汉字)

NPM version Build Status Coverage Status


Convert Han to pinyin. useful for phonetic notation, sorting, and searching.

Note: This module both support Node and Web browser.

Python version see mozillazg/python-pinyin


  • Segmentation for heteronym words.
  • Support Traditional and Simplified Chinese.
  • Support multiple pinyin style.


via npm:

npm install pinyin


for developer:

var pinyin = require("pinyin");

console.log(pinyin("中心"));    // [ [ 'zhōng' ], [ 'xīn' ] ]
console.log(pinyin("中心", {
  heteronym: true                // Enable heteronym mode.
}));                            // [ [ 'zhōng', 'zhòng' ], [ 'xīn' ] ]
console.log(pinyin("中心", {
  heteronym: true,              // Enable heteronym mode.
  segment: true                 // Enable Chinese words eegmentation, fix most heteronym problem.
}));                            // [ [ 'zhōng' ], [ 'xīn' ] ]
console.log(pinyin("中心", {
  style: pinyin.STYLE_INITIALS, // Setting pinyin style.
  heteronym: true
}));                            // [ [ 'zh' ], [ 'x' ] ]

for cli:

$ pinyin 中心
zhōng xīn
$ pinyin -h


<Array> pinyin(words[, options])

Convert Han (汉字) to pinyin.

options argument is optional, for sepcify heteronym mode and pinyin styles.

Return a Array<Array<String>>. If one of Han is heteronym word, it would be have multiple pinyin.

Number, b)

Default compare implementation for pinyin.


<Boolean> options.segment

Enable Chinese word segmentation. Segmentation is helpful for fix heteronym problem, but performance will be more slow, and need more CPU and memory.

Default is false.

<Boolean> options.heteronym

Enable or disable heteronym mode. default is disabled, false.


Specify pinyin style. please use static properties like STYLE_*. default is .STYLE_TONE. see Static Property for more.

Static Property


Normal mode.

Example: pin yin


Tone style, this is default.

Example: pīn yīn


tone style by postfix number [0-4].

Example: pin1 yin1


tone style by number [0-4] after phonetic notation character.

Example: pin1 yin1


Initial consonant (of a Chinese syllable).

Example: pinyin of 中国 is zh g

Note: when a Han (汉字) without initial consonant, will convert to empty string.


First letter style.

Example: p y


npm test


What's the different Node version and Web version?

pinyin support Node and Web browser now, the API and usage is complete same.

But the Web version is simple than Node version. Just frequently-used dict, without segmentation, and the dict is compress for web.

Because of Traditional and Segmentation, the convert result will be not complete same. and the test case have some different too.

Feature Web version Node version
Dict Frequently-used Dict, Compress. Complete Dict, without Compress.
Segmentation NO Segmentation options.
Traditional NO Full Traditional support.

How to sort by pinyin?

This module provide default compare implementation:

const pinyin = require('pinyin');

const data = '我要排序'.split('');
const sortedData = data.sort(;

But if you need different implementation, do it like:

const pinyin = require('pinyin');

const data = '我要排序'.split('');

// Suggest you to store pinyin result by data persistence.
const pinyinData = => ({
  han: han,
  pinyin: pinyin(han)[0][0], // Choose you options and styles.
const sortedData = pinyinData.sort((a, b) => {
  return a.pinyin.localeCompare(b.pinyin);
}).map(d => d.han);


If this module is helpful for you, please Star this repository.

And you have chioce donate to me via Aliapy or WeChat:, WeChat:hotoome

or donate my dear wife @lizzie direct:, WeChat:SunsetSunrising

The two donate way will have the same result.