pinyin-tone-convert

0.0.2 • Public • Published

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.

/pinyin-tone-convert/

    Package Sidebar

    Install

    npm i pinyin-tone-convert

    Weekly Downloads

    1

    Version

    0.0.2

    License

    MIT

    Unpacked Size

    6.16 kB

    Total Files

    6

    Last publish

    Collaborators

    • oleglegun