Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

nihongo

1.0.1 • Public • Published

nihongo.js

Install

npm install nihongo

API

nihongo.js has methods for analysing characters and sentences and parsing sentences.

Analysis

// Determine whether or not a character is a hiragana
nihongo.isHiragana(""); // true
 
// Determine whether or not a character is a katakana
nihongo.isKatakana(""); // true
 
// Determine whether or not a character is a kana
nihongo.isKana(""); // true
nihongo.isKana(""); // true
 
// Determine whether or not a character is a kanji
nihongo.isKanji(""); // true
 
// Determine whether or not a character is Japanese
nihongo.isJapanese(""); // true
nihongo.isJapanese(""); // true
nihongo.isJapanese(""); // true
nihongo.isJapanese("a"); // false
 
// Determine whether or not a character is a kyouiku kanji
nihongo.isKyouikuKanji(""); // true
 
// Determine whether or not a character is a jouyou kanji
nihongo.isJouyouKanji(""); // true
 
// Get the kyouiku grade of a kanji
nihongo.getKyouikuGrade(""); // 1
 
// Determine whether or not a string contains hiragana
nihongo.hasHiragana("これはクッキーです。"); // true
 
// Determine whether or not a string contains katakana
nihongo.hasKatakana("これはクッキーです。"); // true
 
// Determine whether or not a string contains kana
nihongo.hasKana("これはクッキーです。"); // true
 
// Determine whether or not a string contains kanji
nihongo.hasKanji("これはクッキーです。"); // false
 
// Determine whether or not a string contains Japanese
nihongo.hasJapanese("This sentence has no Japanese"); // false
 
// Determine whether or not a string contains hiragana, katakana and kanji
nihongo.contains("これはクッキーです。"); // {hiragana: true, katakana: true, kanji: false}

Parsing

// Extract an array of hiragana from a string
nihongo.parseHiragana("これはクッキーです。"); // ["こ", "れ", "は", "で", "す"]
 
// Extract an array of katakana from a string
nihongo.parseKatakana("これはクッキーです。"); // ["ク", "ッ", "キ", "ー"]
 
// Extract an array of kana from a string
nihongo.parseKana("これはクッキーです。"); // ["こ", "れ", "は", "ク", "ッ", "キ", "ー", "で", "す"]
 
// Extract an array of kanji from a string
nihongo.parseKanji("私はクッキーが大好きです。"); // ["私", "大", "好"]
 
// Extract an array of consecutive kanji from a string
nihongo.parseKanjiCompounds("私はクッキーが大好きです。"); // ["私", "大好"]
 
// Extract an array if all sections of Japanese from a string
nihongo.parseJapanese("This is an English sentence. This sentence contains both 日本語 and English. これは日本語の文。"); // ["日本語", "これは日本語の文"]

Tests

$ npm install
$ npm test

License

MIT

install

npm i nihongo

Downloadsweekly downloads

132

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar