hanzist

some util function about hanzi. 一些處理漢字的函式工具.

History

• 0.0.12 ~ 0.0.13 fix some bug, ex: 十的前面可省略一, 一百一十八 省略為 ‵一百十八`
• 0.0.11 新增 extractionHanNumber 取出字串中含有的漢字數字
• 0.0.7 ~ 0.0.10 fix some bug
• 0.0.6 新增 toNumber 漢字數字轉阿拉伯數字, isHanNumber 判斷是否是漢字數字, toHanNumber 阿拉伯數字轉漢字數字
• 0.0.5 fix isString
• 0.0.4 新增 cutDBCHstr 剪裁雙位元字寬字串
• 0.0.3 新增 isFullwidth 單字是否為全形字, fontwidth 計算字寬
• 0.0.2 新增 fullwidthCase 轉全形字, halfwidthCase 轉半形字
• 0.0.1 目前只有 normalize

Install

> npm install hanzist

How to use it

normalize,

const hanzist = require('hanzist');

var str = 'he羅, ㆗\u{3246}';
// => 'he羅, ㆗㉆'

hanzist.normalize(str);
// => 'he羅, 中文'

normalize 會將字碼在

• Kanbun(0x3190 ~ 0x319F, 古典日文中使用來指示閱讀順序的註釋字符),
• Enclosed_CJK_Lettersvar_Brackets(0x3220 ~ 0x3247, 帶括弧的中日韓表意文字, 0x3220 ~ 0x3243 為帶括弧文字, 0x3244 ~ 0x3247 是新增的帶圓圈文字),
• Enclosed_CJK_Lettersvar_Circles(0x3280 ~ 0x32B0 , 帶圓圈的中日韓表意文字),
• Ideographic_Telegraph_Symbols_Months(0x32C0 ~ 0x32CB, 電報文字中的 1 月到 12 月),
• Ideographic_Telegraph_Symbols_Hours(0x3358 ~ 0x3370, 電報文字中的 0 點到 24 點),
• Japanese_Era_Names_And_Corporation(0x337B ~ 0x337F, 日本年號跟公司),
• Ideographic_Telegraph_Symbols_Days(0x33E0 ~ 0x33FE, => 電報文字中的 1 日到 31 日),
• Private_Use_Area(0xE000 ~ 0xF8FF, 私有區域, 沒有統一的對應),
• CJK_Compatibility_Ideographs(0xF900 ~ 0xFAFF, 日韓相容表意文字, 目前只編到 0xFAD9)

中的字盡量改為位在 0x4E00 ~ 0x9FFF 之間的字. 讓異體或含中文的特殊符號, 盡量以相同的字碼統一顯示.

fullwidthCase, halfwidthCase

var str = '［￡\u{FF5E}£]中文1２3';
// => '［￡～£]中文1２3'

hanzist.fullwidthCase(str);
// => '［￡～￡］中文１２３'

hanzist.halfwidthCase(str);
// => '[£~£]中文123'

fullwidthCase 會將字串內的字轉為全形字, halfwidthCase 會將字串內的字轉為半形字. 第二參數可支援片假名與韓文.

var str = '片假名:\u{FF90}, 韓文:\u{FFB0}';
// => '片假名:ﾐ, 韓文:ﾰ'

hanzist.fullwidthCase(str,['Katakana']);
// => '片假名：ミ，　韓文：ﾰ'

hanzist.fullwidthCase(str,['Hangul']);
// => '片假名：ﾐ，　韓文：ㅀ'

isFullwidth 判斷單字是否為全形字,

var str = '中文1２3';
hanzist.isFullwidth(str[0]);
// => true

hanzist.isFullwidth(str.charCodeAt(0));
// => true

hanzist.isFullwidth(str[2]);
// => false

fontwidth 計算字寬, 全形字長度為 2, 控制或合併複合字為 0, 其他為 1. 全形字以 unicode 標示為 full-width 或 wide 為準.

var str = '中文1２3';
hanzist.fontwidth(str);
// => 8

var str = '中文\n1２3';
// => 8

判斷字寬, 借用 east-asian-width建立的 code_point_utils, 感謝 Vangie Du. 但因為 east-asian-width v0.1.1 在計算字寬上對 codepoint 的判斷有些問題, 故並未使用其 char_width 函式. 且因為應用上需求不同, 原 east-asian-width 對控制字元傳回 2, 但 fontwidth 因其不可見而傳回 0.

cutDBCHstr 剪裁雙位元字寬字串, 開始剪裁位置若位於雙位元字寬字(全形字)中間, 則會包含該字元; 結束剪裁位置若位於雙位元字寬字中間, 則 不 會包含該字元.

var str = 'The中文word';
hanzist.cutDBCHstr(str, 1);
// => 'e中文word'

hanzist.cutDBCHstr(str, 1, 2);
// => 'e中'

hanzist.cutDBCHstr(str, 2, 2);
// => '中文'

toNumber 漢字數字轉阿拉伯數字, 只支援正整數, 最大到 MAX_SAFE_INTEGER, 九千零七兆一千九百九十二億五千四百七十四萬零九百九十一, 採萬進位, 萬以下是十進位，萬以後為萬進位，即"萬萬為億、 萬億為兆、 萬兆為京",

hanzist.toNumber('一萬二千三百四十五')
// => 12345

hanzist.toNumber('1萬2千345')
// => 12345

hanzist.toNumber('壹萬貳千參百肆拾伍')
// => 12345

漢字數字表示有幾個較特別的例子,

// 尾數為零可不表示
hanzist.toNumber('一萬二')
// => 12000

// 首數字為"一", 可省略
hanzist.toNumber('萬二')
// => 12000

// 有空缺的單位需補零
hanzist.toNumber('一萬零二')
// => 10002

// 零開頭或結尾的數字是不合法的
hanzist.toNumber('零二')
// => NaN

// 逢萬進位, 所以"萬萬"是不合法的
hanzist.toNumber('萬萬')
// => NaN

// 連續的單位沒有數詞表示, 是不合法的, 但首數字為一, 可省略數詞
// ex: 萬百 => 一萬百 (x), "百"不是首數字不可省略數詞, 表示是"一萬個一百"還是"一萬零一百"?
hanzist.toNumber('萬百')
// => NaN

// ex: 百萬 => 一百萬 (v)
hanzist.toNumber('百萬')
// => 1000000

// ex: 萬零百 => 一萬零一百 (v), "百"前補零, 是首數字可省略數詞 
hanzist.toNumber('萬零百')
// => 10100

// "萬"與"千"之間沒有空缺的單位, 
hanzist.toNumber('萬零千')
// => NaN

isHanNumber 判斷是否是漢字數字,

hanzist.isHanNumber('萬零千')
// => false

toHanNumber 阿拉伯數字轉漢字數字,

hanzist.toHanNumber(9007199254740991)
// => '九千零七兆一千九百九十二億五千四百七十四萬零九百九十一'

API

normalize(str, options)

Arguments

str (String): The string to normalize. 

options (Array): The alt word tables. default all. 目前可用的 [('Kanbun|Enclosed_CJK_Lettersvar_Brackets|Enclosed_CJK_Lettersvar_Circles|Ideographic_Telegraph_Symbols_Months|Ideographic_Telegraph_Symbols_Hours|Japanese_Era_Names_And_Corporation|Ideographic_Telegraph_Symbols_Days|Private_Use_Area|CJK_Compatibility_Ideographs')]

Returns

(String): Returns the normalize string.

fullwidthCase(str, fontset), halfwidthCase(str, fontset)

Arguments

str (String): The string to fullwidth or halfwidth. 

fontset (['Katakana'|'Hangul']): 目前可用的 'Katakana'(片假名)與, 'Hangul'(韓文). 

Returns

(String): Returns the fullwidth or halfwidth string.

isFullwidth(cp)

Arguments

cp (String|Number): The codepoint or string first char. 

Returns

(Boolean): Returns true if fullwidth.

fontwidth(str)

Arguments

str (String): The string. 

Returns

(Number): Returns the width.

cutDBCHstr(str, start, length)

Arguments

str (String): The string. 

start (Number): Location at which to begin extracting characters. 開始剪裁的位置. 1 是等於兩個位元字寬(一個全形字).

length (Number): The number of characters to extract. 1 是等於兩個位元字寬. 沒有值會傳回開始字元後的所有字元.

Returns

(Number): Returns new string of the extracted. If length is 0 or a negative number, an empty string is returned.