simple-romaji-kana

Simple Hepburn-based romaji-kana converters

Usage no npm install needed!

<script type="module">
  import simpleRomajiKana from 'https://cdn.skypack.dev/simple-romaji-kana';
</script>

README

Simple Hepburn-Based Romaji-Kana Converters

Description

This Node module performs simple Hepburn-based rōmaji-to-kana and kana-to-rōmaji conversions of a given string.

Installing

Switch to your project directory (cd) then run:

npm install simple-romaji-kana

Usage

const { romajiToKana, kanaToRomaji } = require ('simple-romaji-kana');

romajiToKana

romajiToKana (romajiString[, options]);

  • romajiString: string of rōmaji letters; small letters are automatically converted to hiragana (ひらがな) characters, and capital letters to katakana (カタカナ) characters.

  • options (optional): object litteral with two optional keys representing the conversion intents:

    • hiragana: either 'kun-yomi' (by default) or 'gairaigo';
    • katakana: either 'on-yomi' or 'gairaigo' (by default).

  • returns: string of kana characters.

kanaToRomaji

kanaToRomaji (kanaString);

  • kanaString: string of kana characters; hiragana (ひらがな) characters are automatically converted to small rōmaji letters, and katakana (カタカナ) characters to capital rōmaji letters.

  • returns: string of rōmaji letters.

Examples

romajiToKana

const { romajiToKana } = require ('simple-romaji-kana');
const samples =
[
    "tatami",
    "JOU",
    "hanadji",
    "kamidzutsumi",
    "kan'i",
    "kani",
    "KAN",
    "kon'yaku",
    "konnyaku",
    "chousenninjin",
    "maccha",
    "hanawokamu",
    "kwaidan"
];
let options =
{
    hiragana: 'kun-yomi',
    katakana: 'on-yomi'
};
for (let sample of samples)
{
    console.log (`${sample} → ${romajiToKana (sample, options)}`);
}

const { romajiToKana } = require ('simple-romaji-kana');
const gairaigoSamples =
[
    "RAJIUMU",
    "FI-TO",
    "KONYAKKU",
    "MATCHI",
    "BE-TO-VEN",
    "WONBATTO"
];
for (let sample of gairaigoSamples)
{
    console.log (`${sample} → ${romajiToKana (sample)}`);
}

kanaToRomaji

const { kanaToRomaji } = require ('simple-romaji-kana');
const samples =
[
    "たたみ",
    "ジョウ",
    "はなぢ",
    "かみづつみ",
    "かんい",
    "かに",
    "カン",
    "こんやく",
    "こんにゃく",
    "ちょうせんにんじん",
    "まっちゃ",
    "はなをかむ",
    "くゎいだん"
];
for (let sample of samples)
{
    console.log (`${sample} → ${kanaToRomaji (sample)}`);
}

const { kanaToRomaji } = require ('simple-romaji-kana');
const gairaigoSamples =
[
    "ラジウム",
    "フィート",
    "コニャック",
    "マッチ",
    "ベートーヴェン",
    "ウォンバット"
];
for (let sample of gairaigoSamples)
{
    console.log (`${sample} → ${kanaToRomaji (sample)}`);
}

License

The MIT License (MIT).

Copyright © 2019-2020 Michel MARIANI.