muraken720/jaco-js

Japanese character optimizer for JavaScript

★ 1Forks 0JavaScriptGitHub ↗Compare

Project website ↗

README

jaco

Japanese Character Optimizer.

NPM version Bower version 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.

install

for browser

$ bower install jaco

for NodeJS

$ npm install jaco

CLI

$ npm install -g jaco

Usage

for browser

<script src="jaco.min.js"></script>
<script>
jaco.katakanize('ニホンゴのモジなど'); // => ニホンゴノモジナド
jaco.hiraganize('ニホンゴのモジなど'); // => にほんごのもじなど

var jStr01 = new jaco.Jaco('ニホンゴのモジなど');
jStr01.toKatakana(); // => ニホンゴノモジナド
</script>

for NodeJS

var jaco = require('jaco');

jaco.katakanize('ニホンゴのモジなど'); // => ニホンゴノモジナド
jaco.hiraganize('ニホンゴのモジなど'); // => にほんごのもじなど

var jStr01 = new jaco.Jaco('ニホンゴのモジなど');
jStr01.toKatakana(); // => ニホンゴノモジナド

CLI

Usage: jaco [options] <string> [fileOption] <path>

Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -f, --file <path>          convert in file
    -o, --output <path>        output to file
    -K, --katakanize [string]  katakanize method
    -H, --hiraganize [string]  hiraganize method

Methods

Static Functions

jaco.katakanize('ニホンゴのモジなど');
name return type
katakanize string
hiraganize string
hiraganaOnly boolean
katakanaOnly boolean
naturalKanaSort Array

Instance methods of Class Jaco

var instance = new jaco.Jaco('ニホンゴのモジなど');
instance.toString();
name return type bang chainable
toString string ✗ ✗
valueOf string ✗ ✗
concat Jaco ✓ ✓
slice Jaco ✓ ✓
substr Jaco ✓ ✓
substring Jaco ✓ ✓
append Jaco ✓ ✓
prepend Jaco ✓ ✓
replace Jaco ✓ ✓
trim Jaco ✓ ✓
remove Jaco ✓ ✓
test Jaco ✓ ✓
is boolean ✗ ✗
isEmpty boolean ✗ ✗
isOnly boolean ✗ ✗
isOnlyHiragana boolean ✗ ✗
isOnlyKatakana boolean ✗ ✗
isNumeric boolean ✗ ✗
toNumeric Jaco ✓ ✓
combinate Jaco ✓ ✓
toLowerCase Jaco ✓ ✓
toUpperCase Jaco ✓ ✓
toHiragana Jaco ✓ ✓
toKatakana Jaco ✓ ✓
toNarrowKatakana Jaco ✓ ✓
toWideKatakana Jaco ✓ ✓
toNumber number ✗ ✗
size number ✗ ✗
byteSize number ✗ ✗
clone Jaco ✓ ✓
toNarrowJapneseSymbol Jaco ✓ ✓
toWideJapnese Jaco ✓ ✓
toNarrow Jaco ✓ ✓
toWide Jaco ✓ ✓
addVoicedMarks Jaco ✓ ✓
addSemivoicedMarks Jaco ✓ ✓
removeVoicedMarks Jaco ✓ ✓
convertProlongedSoundMarks Jaco ✓ ✓
convertIterationMarks Jaco ✓ ✓
toBasicLetter Jaco ✓ ✓
hasSmallLetter boolean ✗ ✗
toPhoeticKana Jaco ✓ ✓
replaceMap Jaco ✓ ✓

Documents

http://jaco-project.github.io/docs/

Contributors

YusukeHiraomuraken720

Issues