japanese-kana

0.1.2 • Public • Published

japanese-kana

NPM version NPM downloads CircleCI donate

Install

yarn add japanese-kana

CDN: https://unpkg.com/japanese-kana/dist/

Usage

Currently it only supports gojūon, it's nice if you can help with adding dakuon and yōon support.

const kana = require('japanese-kana')
 
kana.line('ka')
//=> return
[ [ '', '' ],
  [ '', '' ],
  [ '', '' ],
  [ '', '' ],
  [ '', '' ] ]
 
kana.getRomajiByKana('')
//=> return `ki`
 
kana.getKanaByRomaji('mo')
//=> return ["も", "モ"]
 
kana.getHiraganaByRomaji('fu')
//=> return 'ふ'

API

line

Get line by first Romaji of each line

Parameters

  • name string The first Romaji of each line

Examples

kana.line('ka')
//=> return
[ [ '', '' ],
[ '', '' ],
[ '', '' ],
[ '', '' ],
[ '', '' ] ]

Returns Array<Array<Hiragana, Katakana>> Kana

getRomajiByKana

Get Romaji By Kana

Parameters

Examples

kana.getRomajiByKana('')
//=> return `ki`

Returns (string | undefined) Romaji

getKanaByRomaji

Get Kana By Romaji

Parameters

Examples

kana.getKanaByRomaji('mo')
//=> return ["も", "モ"]

Returns Array<Hiragana, Katakana> Kana

getHiraganaByRomaji

Get Hiragana by Romaji

Parameters

Examples

kana.getHiraganaByRomaji('fu')
//=> return 'ふ'

Returns string Hiragana

getKatakanaByRomaji

Get Katakana by Romaji

Parameters

Examples

kana.getKatakanaByRomaji('ha')
//=> return 'ハ'

Returns string Katakana

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

japanese-kana © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin

Package Sidebar

Install

npm i japanese-kana

Weekly Downloads

13

Version

0.1.2

License

MIT

Last publish

Collaborators

  • kchan
  • rem