Package Exports

pinyin-tone-convert

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 (pinyin-tone-convert) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Pinyin Tone Convert

Easily convert pinyin tone numbers to tone marks.

Installation

npm install pinyin-tone-convert

Usage

const toneConvert = require('pinyin-tone-convert')

toneConvert('Ni3 hao3 ma5?')
// 'Nǐ hǎo ma?'

toneConvert('Zhong1guo2ren2 ai4 he1 cha2 hai2shi5 ka1fei1?')
// Zhōngguórén ài hē chá háishi kāfēi?

Options

Under the hood this library uses pinyin-tone-parse library and thus passes options object directly to it. Look for all available options here.

const toneConvert = require('pinyin-tone-convert')

toneConvert('pinyin...', options)

Conversion Rules

This library works based on these rules:

a and e trump all other vowels and always take the tone mark.
In the combination ou, o takes the mark.
In all other cases, the final vowel takes the mark.

Tests

npm test

License

MIT.