hatsuon v2.0.0

発音 hatsuon

Japanese pitch accent tools

Why?

Japanese dictionaries often display the pitch accent of a word with a single number that determines where the pitch falls. This can be difficult to mentally visualize without counting through the mora of the word. This library provides useful tools for generating pitch patterns which can then be easily displayed via SVG.

Installation

npm install --save hatsuon

Demo

Visualization Example

Usage

import { hatsuon } from 'hatsuon';

hatsuon({ reading: 'ちゅうがっこう', pitchNum: 3 });
// =>
{
  reading: 'ちゅうがっこう',
  pitchNum: 3,
  morae: ['ちゅ', 'う', 'が', 'っ', 'こ', 'う'],
  // low, high, high, low, low, low, low*
  // *following particle (は、が, の etc) pitch
  pattern: [0, 1, 1, 0, 0, 0, 0],
  patternName: '中高', // nakadaka
}

Extra available utils (see source for documentation):

import {
  isDigraph,
  getMorae,
  getMoraCount,
  makePitchPattern,
  getPitchPatternName,
  getPitchNumFromPattern,
} from 'hatsuon';

Related

WanaKana : Japanese romaji <-> kana transliteration library

Contributors

Thanks goes to these people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © Duncan Bay