npm i pinyin


🇨🇳 汉字拼音 ➜ hàn zì pīn yīn

by 闲耘™

3.0.0-alpha.5 (see all)License:MITTypeScript:Built-In
npm i pinyin

pīnyīn (v3)

pinyin, The convert tool of chinese pinyin.

NPM version Build Status Coverage Status Language Grade: JavaScript NPM downloads

Web Site: 简体中文 | English

README: 简体中文 | English

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@alpha --save


for developer:

import pinyin from "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 segmentation, fix most heteronym problem.
}));                            // [ [ 'zhōng' ], [ 'xīn' ] ]

console.log(pinyin("我喜欢你", {
  segment: true,                // Enable segmentation. Needed for grouping.
  group: true                   // Group pinyin segments
}));                            // [ [ 'wǒ' ], [ 'xǐhuān' ], [ 'nǐ' ] ]

console.log(pinyin("中心", {
  style: pinyin.STYLE_INITIALS, // Setting pinyin style.
  heteronym: true
}));                            // [ [ 'zh' ], [ 'x' ] ]

console.log(pinyin("华夫人", {
  mode: "surname",              // 姓名模式。
}));                            // [ ['huà'], ['fū'], ['rén'] ]

for cli:

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



The types for the second argument of pinyin method.

export interface IPinyinOptions {
  style?: IPinyinStyle; // output style of pinyin.
  mode?: IPinyinMode, // mode of pinyin.
  segment?: IPinyinSegment | boolean;
  heteronym?: boolean;
  group?: boolean;
  compact?: boolean;


The output style of pinyin.

export type IPinyinStyle =
  "normal" | "tone" | "tone2" | "to3ne" | "initials" | "first_letter" | // Suggest.
  0        | 1      | 2       | 5       | 3          | 4;               // compatibility.


The mode of pinyin.

// - NORMAL: Default mode is normal mode.
// - SURNAME: surname mode, for chinese surname.
export type IPinyinMode =
  "normal" | "surname" |


The segment method.

  • Default is disable segment: false
  • If set true, use "segmentit" module for segment in Web, use "nodejieba" for segment in Node.
  • Also specify follow string for segment (bug just "segmentit" in web):
export type IPinyinSegment = "nodejieba" | "segmentit" | "@node-rs/jieba";


<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.


Group pinyin by phrases. for example:

wǒ xǐhuān


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


pinyin mode, default is pinyin.MODE_NORMAL. If you cleared in surname scene, use pinyin.MODE_SURNAME maybe better.

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


Normal mode. This is the default mode.


Surname mode. If chinese word is surname, The pinyin of surname is prioritized.


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.

FeatureWeb versionNode version
DictFrequently-used Dict, Compress.Complete Dict, without Compress.
SegmentationNOSegmentation options.
TraditionalNOFull 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



8mos ago
1yr ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review