nahanil / zh-cangjie

Node.js package to convert strings to/from cangjie chars (人弓火 -> ONF / ONF -> 人弓火)

zh-cangjie

• Convert strings to/from cangjie chars (人弓火 -> ONF || ONF -> 人弓火)
• Convert chinese characters to/from cangjie (雨 -> 一中月卜 || MLBY -> 雨).

Created for zhdict.net

Usage

var cangjie = require('zh-cangjie');

// Convert alpha string into cangjie characters
cangjie.toCangjie("MGILG")
// "一土戈中土"

// Convert cangjie string into alpha
cangjie.fromCangjie("一土戈中土")
// "MGILG"

/*
 * From v0.2.0
 */
// Get the cangjie equivalent of a given character
let found = await cangjie.forCharacter('雨');
// - OR -
cangjie.forCharacter('雨').exec(function(err, found){
  console.log(found.alpha); // MLBY
  console.log(found.cangjie); // 一中月卜
});

// Search for characters based on cangjie string
// Sometimes this will return multiple characters
let found = await cangjie.findCharacters("MLBY");
// - OR -
cangjie.findCharacters("MLBY", function(err, found) {
  console.log(found);  // ['雨']
});

let found = await cangjie.findCharacters("一中月卜");
// - OR -
cangjie.findCharacters("一中月卜", function(err, found) {
  console.log(found);  // ['雨']
});

let found = await cangjie.findCharacter("YWLV");
// - OR -
cangjie.findCharacters("YWLV", function(err, found) {
  console.log(found);  // ['褱', '還']
});


// Search for characters whos cangjie equivalent begins with the given string
// This could be used, for example, in a character prediction widget for
// a soft cangjie keyboard
let found = await cangjie.findCharacters("一中");
cangjie.findCharacters("一中", function(err, found) {
  console.log(found);
  // [ '工', '更', '雨', '兩', '亞', '丌', '丏', '両', '丣', '帀', '㓚', '㧭', '厞', '覀' ]
});

Changes

4 December 2018 - 0.2.0

• .findCharacters() replaces .search() and .findCharacter()
• findCharacters() and fromCharacter() are await-able
• Requires Node.js 8+ (async/await)

9 September 2016 - 0.1.0

• Added ability to lookup cangjie for a given Chinese character (based on data from Unihan/Unicode Character Database
• Added ability to search for characters based on a full or partial cangjie string (as either [A-Z]+ or cangjie 'radicals')

23 August 2015 - 0.0.2

Initial release

TODO

• Potentially paginate results returned by search() findCharacters()

Notes

This is currently under development. API may/likely will grow and change.

Character <-> cangjie data was compiled from the Unicode Character Database.

Unicode Character Database
Copyright © 1991-2016 Unicode, Inc. All rights reserved.
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.

zh-cangjie's Issues

typscript support?

Can anyone provide typescript support?
THanks.