pinyin-tone-convert

Convert Pinyin tone numbers to tone marks.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
pinyin-tone-convert
310.0.25 years ago5 years agoMinified + gzip package size for pinyin-tone-convert in KB

Readme

Pinyin Tone Convert
Build Status Coverage Status code style: prettier License: MIT
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: 1. a and e trump all other vowels and always take the tone mark. 2. In the combination ou, o takes the mark. 3. In all other cases, the final vowel takes the mark.

Tests

npm test

License

MIT.