@jikyo/suji

suji is a converter library from Japanese number notation to numerical value, and from numerical notation to Japanese Kansuji notation.

Note

Note: suji only support UTF-8 encoding.

Installation

npm i @jikyo/suji

Usage

To convert from Japanese number notation to numerical string or value

Japanese number notation can include Kansuji. The string 「１つの価格が二兆30万五千十7円になります。」 will be converted to two integers, 1 and 2000000005017. And also, 「打率は三割二部五厘です。」 will be a float 0.325.

suji.value:

The return value is a converted string. If the input string has no number notation, value returns the input string.

const suji = require('@jikyo/suji');
suji.value('一つの価格が二兆30万五千十7円になります。');
// 1つの価格が2000000305017円になります。

suji.values:

values returns a list of result objects. If the input string has no number notation, suji returns a empty list. The result object has three keys: val, beg, and end:

Properties	Values
val	the numerical value of the number notation.
beg	the start postion of the found number notation at the input string.
end	the end postion of the found number notation.

const suji = require('@jikyo/suji');
suji.values('一つの価格が二兆30万五千十7円になります。');
// [ { val: 1, beg: 0, end: 1 }, { val: 2000000305017, beg: 6, end: 15 } ]

To convert from numeric notation to Japanese Kanji notation

The string 「二兆30万五千十7円になります。」 will be converted to the Kansuji string, 「二兆三十万五千十七」. The boolean flag one is interpreted as whether to display the first character 「一」 or not. The output of suji.kansuji('1000万') will be converted to 「一千万」 (as default), and the output of suji.kansuji('1000万', false) will be converted to 「千万」. Note that suji does not support numerical notation after the decimal point. If the inpust string is 32.01, the output will 「三十二.01」, not 「三十二割一厘」.

suji.kansuji:

The retun value is a covnerted string. If the input string has no number notation, kansuji returns the input string.

const suji = require('@jikyo/suji');
suji.kansuji('価格は￥10,000,056です。'); // 価格は￥一千万五十六です。
suji.kansuji('価格は￥10,000,056です。', false); // 価格は￥千万五十六です。

suji.kansujis:

The return value is a list of result objects. If the input string has no number notation, kansujis returns a empty list. The result object has three keys: val, beg, and end:

Properties	Values
val	the Kansuji notation string.
beg	the start postion of the found number notation at the input string.
end	the end postion of the found number notation.

const suji = require('@jikyo/suji');
suji.kansujis('価格は￥10,000,056です。');
// [ { beg: 4, end: 14, val: '一千万五十六' } ]
suji.kansujis('価格は￥10,000,056です。', false);
// [ { beg: 4, end: 14, val: '千万五十六' } ]

suji is a one-pass parser. That is, suji parse a source text from the head to the end only once.

License

MIT