jaco

Japanese Character Optimizer.


Keywords
japanese, javascript, string, character, katakana, hiragana, fullwidth, halfwidth, jaco, japanese-language, nodejs, phonics, sort, surrogate
License
MIT
Install
bower install jaco

Documentation

jaco

Japanese Character Optimizer. [English | ๆ—ฅๆœฌ่ชž]

NPM version Coverage Status Build Status Dependency Status devDependency Status

What is

This module optimize Japanese characters.

Convert to Katakana from Hiragana mutually, or sort list by natural phonetic order, or convert to halfwidth from fullwidth mutually.

functions

  • Convert Hiragana <-> Katakana
  • Convert halfwidth <-> fullwidth
  • Check Hiragana, Katakana, halfwidth, fullwidth, and so on.
  • Sort by natural phonetic order.
    • Supported voiced marks, prolonged sound marks, iteration marks.
  • Has compatible native string object API.

installation

for NodeJS

$ yarn add jaco

CLI

$ npm i -g jaco

Usage

// Partial functions
import toKatakana from 'jaco/fn/toKatakana';
import toHiragana from 'jaco/fn/toHiragana';

toKatakana('ใƒ‹ใƒ›ใƒณใ‚ดใฎใƒขใ‚ธใชใฉ'); // => ใƒ‹ใƒ›ใƒณใ‚ดใƒŽใƒขใ‚ธใƒŠใƒ‰
toHiragana('ใƒ‹ใƒ›ใƒณใ‚ดใฎใƒขใ‚ธใชใฉ'); // => ใซใปใ‚“ใ”ใฎใ‚‚ใ˜ใชใฉ
// Construct instance
import Jaco from 'jaco';

new Jaco('ใƒ‹ใƒ›ใƒณใ‚ดใฎใƒขใ‚ธใชใฉ').toKatakana(); // => ใƒ‹ใƒ›ใƒณใ‚ดใƒŽใƒขใ‚ธใƒŠใƒ‰

CLI

Usage: jaco [options] <path or string>

Options:

  -V, --version                      output the version number
  -K, --katakanize <path or string>  convert to Katakana
  -H, --hiraganize <path or string>  convert to Hiragana
  -h, --help                         output usage information

Functions

Function Args Description
addSemivoicedMarks str ๅŠๆฟ็‚นใ‚’่ฟฝๅŠ ใ™ใ‚‹
addVoicedMarks str ๆฟ็‚นใ‚’่ฟฝๅŠ ใ™ใ‚‹
byteSize str ๆ–‡ๅญ—ๅˆ—ใฎใƒใ‚คใƒˆใ‚ตใ‚คใ‚บใ‚’่ฟ”ใ™
charAt str [, index] ๆ–‡ๅญ—ๅˆ—ใ‹ใ‚‰ๆŒ‡ๅฎšไฝ็ฝฎใฎๆ–‡ๅญ—ใ‚’่ฟ”ใ™
charCodeAt str [, index] ๆŒ‡ๅฎšไฝ็ฝฎใฎ Unicode ใ‚ณใƒผใƒ‰ใƒใ‚คใƒณใƒˆใ‚’่ฟ”ใ™
combinateSoundMarks str [, convertOnly] ๆฟ็‚นใƒปๅŠๆฟ็‚นใจใฒใ‚‰ใŒใชใƒปใ‹ใŸใ‹ใชใ‚’็ตๅˆใ•ใ›ใ‚‹
concat ...str ๅ†ๅธฐ็š„ใซๆ–‡ๅญ—ๅˆ—้€ฃ็ตใ‚’ใŠใ“ใชใ†
convertIterationMarks str ็นฐใ‚Š่ฟ”ใ—่จ˜ๅทใ‚’ใ‹ใชใซ็ฝฎใๆ›ใˆใ‚‹
convertProlongedSoundMarks str ้•ท้Ÿณ็ฌฆใ‚’ใ‹ใชใซ็ฝฎใๆ›ใˆใ‚‹
endWith str, search [, position] ๅผ•ๆ•ฐใซๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใŒๆœซๅฐพใจๅˆ่‡ดใ™ใ‚‹ใ‹
has str, characters ่ฉฒๅฝ“ใฎๆ–‡ๅญ—ใฎใ„ใšใ‚Œใ‹ใ‚’ๅซใ‚“ใงใ„ใ‚‹ใ‹ใฉใ†ใ‹
hasSmallLetter str ๅฐๆ›ธใๆ–‡ๅญ—ใ‚’ๅซใ‚€ใ‹ใฉใ†ใ‹
hasSurrogatePair str ใ‚ตใƒญใ‚ฒใƒผใƒˆใƒšใ‚ขๆ–‡ๅญ—ๅˆ—ใ‚’ๅซใ‚“ใงใ„ใ‚‹ใ‹ใฉใ†ใ‹
hasUnpairedSurrogate str ใƒšใ‚ขใซใชใฃใฆใ„ใชใ„ใ‚ตใƒญใ‚ฒใƒผใƒˆใ‚ณใƒผใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๅซใ‚“ใงใ„ใ‚‹ใ‹ใฉใ†ใ‹
includes str, search [, position] ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใŒๆœ€ๅˆใซ็พใ‚Œใ‚‹ใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใ‚’่ฟ”ใ™
indexOf str, search [, fromIndex] ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใŒๆœ€ๅˆใซ็พใ‚Œใ‚‹ใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใ‚’่ฟ”ใ™
is str, target ๅฎŒๅ…จใƒžใƒƒใƒ
isEmpty str ๆ–‡ๅญ—ใŒ็ฉบใ‹ใฉใ†ใ‹
isNumeric str [, negative [, floatingPoint]] ๆ•ฐๅญ—ใ ใ‘ใงๆง‹ๆˆใ•ใ‚Œใฆใ„ใ‚‹ใ‹ใฉใ†ใ‹
isOnly str, characters ่ฉฒๅฝ“ใฎๆ–‡ๅญ—ใ ใ‘ใงๆง‹ๆˆใ•ใ‚Œใฆใ„ใ‚‹ใ‹ใฉใ†ใ‹
isOnlyHiragana str ใฒใ‚‰ใŒใชใ ใ‘ใงๆง‹ๆˆใ•ใ‚Œใฆใ„ใ‚‹ใ‹ใฉใ†ใ‹
isOnlyKatakana str ใ‚ซใ‚ฟใ‚ซใƒŠใ ใ‘ใงๆง‹ๆˆใ•ใ‚Œใฆใ„ใ‚‹ใ‹ใฉใ†ใ‹
lastIndexOf str, search [, fromIndex] ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใŒๆœ€ๅพŒใซ็พใ‚Œใ‚‹ใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใ‚’่ฟ”ใ™
matches str, regexp ๆญฃ่ฆ่กจ็พใซๅฏพใ™ใ‚‹ๆ–‡ๅญ—ๅˆ—ใฎใƒžใƒƒใƒใƒณใ‚ฐใฎ้š›ใซใ€ใใฎใƒžใƒƒใƒ็ตๆžœใ‚’็ด”็ฒ‹ใช้…ๅˆ—ใงๅพ—ใ‚‹
naturalKanaOrder a, b ้…ๅˆ—ใฎไบ”ๅ้Ÿณ้ †ใ‚ฝใƒผใƒˆใ‚’ใ™ใ‚‹ใŸใ‚ใฎใ‚ฝใƒผใƒˆ้–ขๆ•ฐ
naturalKanaSort array ้…ๅˆ—ใฎไบ”ๅ้Ÿณ้ †ใ‚ฝใƒผใƒˆใ‚’ใ™ใ‚‹
padEnd str, targetLength [, padString] ๆœ€็ต‚็š„ใชๆ–‡ๅญ—ๅˆ—ใŒๆŒ‡ๅฎšใ•ใ‚ŒใŸ้•ทใ•ใซๅˆฐ้”ใ™ใ‚‹ใ‚ˆใ†ใซๆ–‡ๅญ—ๅˆ—ใงๅปถ้•ทใ™ใ‚‹
padStart str, targetLength [, padString] ๆœ€็ต‚็š„ใชๆ–‡ๅญ—ๅˆ—ใŒๆŒ‡ๅฎšใ•ใ‚ŒใŸ้•ทใ•ใซๅˆฐ้”ใ™ใ‚‹ใ‚ˆใ†ใซๆ–‡ๅญ—ๅˆ—ใ‚’ๅ…ˆ้ ญใซ่ฟฝๅŠ ใ™ใ‚‹
remove str, pattern ๆ–‡ๅญ—ๅˆ—ใ‚’ๅ–ใ‚Š้™คใ
removeUnpairedSurrogate str ใƒšใ‚ขใซใชใฃใฆใ„ใชใ„ใ‚ตใƒญใ‚ฒใƒผใƒˆใ‚ณใƒผใƒ‰ใƒใ‚คใƒณใƒˆใฎๅ‰Š้™ค
removeVoicedMarks str [, ignoreSingleMark] ๆฟ็‚นใƒปๅŠๆฟ็‚นใ‚’ๅ–ใ‚Š้™คใ
repeat str, times ๆ–‡ๅญ—ๅˆ—ใ‚’็นฐใ‚Š่ฟ”ใ™
replace str, pattern, replacement ๆ–‡ๅญ—ๅˆ—ใ‚’ใƒ‘ใ‚ฟใƒผใƒณใง็ฝฎๆ›ใ™ใ‚‹
replaceFromMap str, convMap ใ‚ญใƒผใŒใƒ‘ใ‚ฟใƒผใƒณใƒปๅ€คใŒ็ฝฎๆ›ๆ–‡ๅญ—ๅˆ—ใฎใƒใƒƒใ‚ทใƒฅใƒžใƒƒใƒ—ใซใ‚ˆใฃใฆ็ฝฎๆ›ใ™ใ‚‹
search str, pattern ๆญฃ่ฆ่กจ็พใซใƒžใƒƒใƒใ—ใŸใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใ‚’่ฟ”ใ™
slice str, start [, end] ๆ–‡ๅญ—ไฝ็ฝฎใซใ‚ˆใ‚‹ๆŠฝๅ‡บ
split str, separator ๆ–‡ๅญ—ๅˆ—ใฎ้…ๅˆ—ใซๅˆ†ๅ‰ฒใ™ใ‚‹
startsWith str, search [, position] ๅผ•ๆ•ฐใซๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใŒๅ…ˆ้ ญใจๅˆ่‡ดใ™ใ‚‹ใ‹
substr str, start [, length] ๆŒ‡ๅฎšใ—ใŸไฝ็ฝฎใ‹ใ‚‰ๆŒ‡ๅฎšใ—ใŸๆ•ฐใ ใ‘ๆ–‡ๅญ—ๅˆ—ใ‚’ๆŠฝๅ‡บ
substring str, indexA, indexB ๆŒ‡ๅฎšใ—ใŸไฝ็ฝฎใฎ้–“ใฎๆ–‡ๅญ—ๅˆ—ใ‚’ๆŠฝๅ‡บ
test str, pattern ใƒ‘ใ‚ฟใƒผใƒณใจใƒžใƒƒใƒใ™ใ‚‹ใ‹ใฉใ†ใ‹
toBasicLetter str ๅฐๆ›ธใๆ–‡ๅญ—ใ‚’ๅŸบๅบ•ๆ–‡ๅญ—ใซๅค‰ๆ›ใ™ใ‚‹
toHiragana str [, isCombinate] ใฒใ‚‰ใŒใชใซๅค‰ๆ›ใ™ใ‚‹
toKatakana str [, toWide] ใ‚ซใ‚ฟใ‚ซใƒŠใซๅค‰ๆ›ใ™ใ‚‹
toNarrow str [, convertJapaneseChars] ๅŠ่ง’ใซๅค‰ๆ›
toNarrowAlphanumeric str ่‹ฑๆ•ฐๅญ—ใ‚’ๅŠ่ง’ใซๅค‰ๆ›
toNarrowJapanese str ใ‚ซใ‚ฟใ‚ซใƒŠใจๆ—ฅๆœฌ่ชžใงไฝฟใ‚ใ‚Œใ‚‹่จ˜ๅทใ‚’ๅŠ่ง’ใซๅค‰ๆ›
toNarrowKatakana str [, fromHiragana] ๅŠ่ง’ใ‚ซใ‚ฟใ‚ซใƒŠใซๅค‰ๆ›ใ™ใ‚‹
toNarrowSign str ่จ˜ๅทใ‚’ๅŠ่ง’ใซๅค‰ๆ›
toNarrowSymbolForJapanese str ๆ—ฅๆœฌ่ชžใงไฝฟใ‚ใ‚Œใ‚‹่จ˜ๅทใ‚’ๅŠ่ง’ใซๅค‰ๆ›
toNumeric str [, negative [, floatingPoint]] ๆ•ฐๅญ—ใซๅค‰ๆ›ใ™ใ‚‹
toPhoeticKana str ใ‚ˆใฟใฎๆ–‡ๅญ—ใซๅค‰ๆ›ใ™ใ‚‹
toWide str ๅ…จ่ง’ใซๅค‰ๆ›
toWideAlphanumeric str ่‹ฑๆ•ฐๅญ—ใ‚’ๅ…จ่ง’ใซๅค‰ๆ›
toWideJapanese str ใ‚ซใ‚ฟใ‚ซใƒŠใจๆ—ฅๆœฌ่ชžใงไฝฟใ‚ใ‚Œใ‚‹่จ˜ๅทใ‚’ๅ…จ่ง’ใซๅค‰ๆ›
toWideKatakana str ๅ…จ่ง’ใ‚ซใ‚ฟใ‚ซใƒŠใซๅค‰ๆ›ใ™ใ‚‹
toWideSign str ่จ˜ๅทใ‚’ๅ…จ่ง’ใซๅค‰ๆ›
toWideSymbolForJapanese str ๆ—ฅๆœฌ่ชžใงไฝฟใ‚ใ‚Œใ‚‹่จ˜ๅทใ‚’ๅ…จ่ง’ใซๅค‰ๆ›