Package Exports

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

Readme

Han(汉)

a module for tanslating Chinese(汉字) to pinyin.

Installation

$ npm install han

Usage

Use the letter method to translate Chinese in to english letter:

var han = require('han');

han.letter('中文') // zhong wen
han.letter('中文', '-') // zhong-wen
han.letter('中文', function(err, result){
  console.log(result) // zhong wen
})

The letter method has 3 params by default, the can all be optional, it depends on you(^^). follow the message below, you can also find it at lib/translate.js:

/* @param `chinese` {String} Chinese word
 * @param [optional] `separator` {String} separator for the letters
 * @param [optional] `callback(err, result)` {Function} if a callback is specified,
 *   the program will use an async way to do the translation 
 */

Testcase

$ npm install han
# or git clone git://github.com/sofish/han.git

$ cd node_modules/han && node testcase.js

Translating Messy Code

Messy code? orginal file is here testcase.js:

var han = require('han');

console.log('原文：要实现 Speaker Deck 那种中文转拼音的')
console.log(han.letter('要实现 Speaker Deck 那种中文转拼音的', '-'), '\n')
// 原文：要实现 Speaker Deck 那种中文转拼音的
// yao-shi-xian-speaker-deck-na-zhong-zhong-wen-zhuan-pin-yin-de

han.letter('中aaaaa中¢∞§¶•誩aa文喳aa', function(err, result){
  if(err) throw err;
  console.log('原文：中aaaaa中¢∞§¶•誩aa文喳aa')
  console.log('异步结果：' + result, '\n')
  // 原文：中aaaaa中¢∞§¶•誩aa文喳aa
  // 异步结果：zhong aaaaa 4e2da2 221ea7b6 2022 jing aa wen zha aa
});

han.letter('中EnglishWords¢∞§¶•ªº文', '-', function(err, result){
  console.log('原文：中EnglishWords¢∞§¶•ªº文')
  console.log('异步结果：' + result)
  // 原文：中EnglishWords¢∞§¶•ªº文
  // 异步结果：zhong-englishwords-221ea7b6-2022aaba-wen
});

License

Licensed under MIT.

Contributers:

Specail thank to fayland for providing the unicode table of Chinese.