# Hikidashi 引き出し — Japanese text tools for JavaScript

> Hikidashi 引き出し — Japanese text tools for JavaScript: era dates (和暦) and kanji numerals both ways, dictionary forms of conjugated words, readings shared over kanji, words pulled from pasted text, sentence difficulty. Zero dependencies.

Install with `npm install @johnmorrisdotca/hikidashi`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/hikidashi/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/hikidashi/docs/guides/getting-started.md): Install Hikidashi, call one function from each drawer, and see what it gives back when it cannot answer.
- [Read era years on a form](https://johnmorrisdotca.github.io/hikidashi/docs/guides/read-era-years.md): Accept 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 dictionary](https://johnmorrisdotca.github.io/hikidashi/docs/guides/extract-words-from-a-paste.md): Turn a pasted page into the words and kanji your dictionary knows, asking the database once.
- [Make a kanji test](https://johnmorrisdotca.github.io/hikidashi/docs/guides/make-a-kanji-test.md): Build a seeded writing and reading test from a word list, the way a Japanese school's かん字テスト sets it.
- [Sort example sentences by difficulty](https://johnmorrisdotca.github.io/hikidashi/docs/guides/sort-sentences-by-difficulty.md): Score every example sentence once from the kanji data you hold, so the easiest can be shown first.
- [Write amounts in kanji, and read them aloud](https://johnmorrisdotca.github.io/hikidashi/docs/guides/write-numbers-in-kanji.md): Show 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 numbers](https://johnmorrisdotca.github.io/hikidashi/docs/guides/embed-text-tools.md): Add native Japanese text tools to an article or form with a custom element or a private iframe.
- [How each drawer works](https://johnmorrisdotca.github.io/hikidashi/docs/guides/how-it-works.md): The rules behind each drawer's answers, and the cases each one refuses.
- [Why it is built this way](https://johnmorrisdotca.github.io/hikidashi/docs/guides/design.md): The choices behind Hikidashi: no data of its own, a refusal rather than a guess, pure functions, one entry point per drawer.
- [Troubleshooting & FAQ](https://johnmorrisdotca.github.io/hikidashi/docs/guides/troubleshooting.md): Why a function answered null, why a word was not found, and the setup problems that come up first.
- [Upgrading, and coming from other libraries](https://johnmorrisdotca.github.io/hikidashi/docs/guides/upgrading.md): What changes between versions, and how Hikidashi compares with Intl's Japanese calendar, wanakana and kuromoji.

## Reference

- [@johnmorrisdotca/hikidashi/wareki](https://johnmorrisdotca.github.io/hikidashi/docs/api/wareki/index.md): 和暦: Japanese era years, and the Western years and dates they name, both ways.
- [@johnmorrisdotca/hikidashi/numerals](https://johnmorrisdotca.github.io/hikidashi/docs/api/numerals/index.md): 漢数字: numbers, in both directions between the two ways of writing them.
- [@johnmorrisdotca/hikidashi/deinflect](https://johnmorrisdotca.github.io/hikidashi/docs/api/deinflect/index.md): 活用: the dictionary form a conjugated word was written from.
- [@johnmorrisdotca/hikidashi/align](https://johnmorrisdotca.github.io/hikidashi/docs/api/align/index.md): 読みの割り当て: a word's reading shared out over its kanji, the way a school's かん字テスト sets it.
- [@johnmorrisdotca/hikidashi/extract](https://johnmorrisdotca.github.io/hikidashi/docs/api/extract/index.md): 抽出: Japanese words and kanji pulled out of pasted text.
- [@johnmorrisdotca/hikidashi/difficulty](https://johnmorrisdotca.github.io/hikidashi/docs/api/difficulty/index.md): 難しさ: how hard an example sentence is to read, so the easiest one can lead.
- [@johnmorrisdotca/hikidashi/element](https://johnmorrisdotca.github.io/hikidashi/docs/api/element/index.md): /element
- [@johnmorrisdotca/hikidashi/element/define](https://johnmorrisdotca.github.io/hikidashi/docs/api/element-define/index.md): /element/define
- [@johnmorrisdotca/hikidashi](https://johnmorrisdotca.github.io/hikidashi/docs/api/main/index.md): Hikidashi 引き出し: a drawer of small Japanese text tools.

## Optional

- [Changelog](https://johnmorrisdotca.github.io/hikidashi/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/hikidashi/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/hikidashi)