Hikidashi documentation

Hikidashi 引き出し — Japanese text tools for JavaScript

Era dates (和暦) and kanji numerals both ways, the dictionary forms of a conjugated word, a reading shared out over its kanji, words pulled from pasted text, and how hard a sentence is to read.

Install

npm install @johnmorrisdotca/hikidashi

Start here

• Getting startedInstall Hikidashi, call one function from each drawer, and see what it gives back when it cannot answer.

Entry points

Guides

How-to

• Read era years on a formAccept a year the way people write it on a Japanese form, in either calendar, and store the Western year.
• Pull words out of a paste with your own dictionaryTurn a pasted page into the words and kanji your dictionary knows, asking the database once.
• Make a kanji testBuild a seeded writing and reading test from a word list, the way a Japanese school's かん字テスト sets it.
• Sort example sentences by difficultyScore every example sentence once from the kanji data you hold, so the easiest can be shown first.
• Write amounts in kanji, and read them aloudShow an amount the way a Japanese page writes it, in the formal characters a contract uses, and as it is said.
• Embed furigana, era years and numbersAdd native Japanese text tools to an article or form with a custom element or a private iframe.

Explanation

• How each drawer worksThe rules behind each drawer's answers, and the cases each one refuses.
• Why it is built this wayThe choices behind Hikidashi: no data of its own, a refusal rather than a guess, pure functions, one entry point per drawer.

Troubleshooting & FAQ

• Troubleshooting & FAQWhy a function answered null, why a word was not found, and the setup problems that come up first.

Upgrading

• Upgrading, and coming from other librariesWhat changes between versions, and how Hikidashi compares with Intl's Japanese calendar, wanakana and kuromoji.

• ChangelogMade from the source of @johnmorrisdotca/hikidashi 1.1.0.
• Every export on one pageapi.html
• The docs for language modelsllms.txt · llms-full.txt