henkan 0.0.0

package/docs/api/functions/isValidArray.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / isValidArray
+
+# Function: isValidArray()
+
+> **isValidArray**(`arg`): `arg is any[]`
+
+Defined in: utils.ts:61
+
+Checks if the argument is an array.
+
+## Parameters
+
+### arg
+
+`any`
+
+The argument
+
+## Returns
+
+`arg is any[]`
+
+Whether or not [arg](#isvalidarray) is an array

package/docs/api/functions/isValidArrayWithFirstElement.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / isValidArrayWithFirstElement
+
+# Function: isValidArrayWithFirstElement()
+
+> **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
+
+Defined in: utils.ts:70
+
+Checks if the argument is an array and has at least one element.
+
+## Parameters
+
+### arg
+
+`any`
+
+The argument
+
+## Returns
+
+`arg is any[]`
+
+Whether or not [arg](#isvalidarraywithfirstelement) is an array and has at least one element

package/docs/api/functions/makeSSML.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / makeSSML
+
+# Function: makeSSML()
+
+> **makeSSML**(`formText`, `fullReading`): `string`
+
+Defined in: utils.ts:1246
+
+Builds SSML text for Japanese words
+
+## Parameters
+
+### formText
+
+`string`
+
+The normal form of the word (usually kanji form)
+
+### fullReading
+
+`string`
+
+The reading of the word (hiragana or katakana)
+
+## Returns
+
+`string`
+
+The SSML text

package/docs/api/functions/shuffleArray.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / shuffleArray
+
+# Function: shuffleArray()
+
+> **shuffleArray**\<`T`\>(`arr`): `T`[]
+
+Defined in: utils.ts:99
+
+Shuffles an array using the `Fisher–Yates shuffle` algorithm
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### arr
+
+`T`[]
+
+The array to be shuffled
+
+## Returns
+
+`T`[]
+
+The shuffled array

package/docs/api/functions/synthesizeSpeech.md

@@ -0,0 +1,39 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / synthesizeSpeech
+
+# Function: synthesizeSpeech()
+
+> **synthesizeSpeech**(`client`, `ssmlText`, `options`): `Promise`\<`null` \| `Buffer`\<`ArrayBuffer`\>\>
+
+Defined in: utils.ts:1331
+
+Synthesizes text to speech audio using \[Amazon Polly\](https://aws.amazon.com/polly/).
+
+## Parameters
+
+### client
+
+`PollyClient`
+
+An Amazon Polly Client instance
+
+### ssmlText
+
+`string`
+
+The text to be spoken, in SSML format
+
+### options
+
+`Omit`\<`SynthesizeSpeechCommandInput`, `"Text"` \| `"TextType"`\>
+
+Other speech generation settings
+
+## Returns
+
+`Promise`\<`null` \| `Buffer`\<`ArrayBuffer`\>\>
+
+A promise resolving with an audio stream buffer or with `null` if the generation failed

package/docs/api/interfaces/DictKanji.md

@@ -0,0 +1,43 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanji
+
+# Interface: DictKanji
+
+Defined in: types.ts:227
+
+KANJIDIC2 entry (kanji)
+
+Equivalent to the `character` KANJIDIC2 element *(excluding some subelements)*
+
+## Properties
+
+### kanji
+
+> `readonly` **kanji**: `string`
+
+Defined in: types.ts:231
+
+The kanji character
+
+***
+
+### misc?
+
+> `optional` **misc**: [`DictKanjiMisc`](DictKanjiMisc.md)
+
+Defined in: types.ts:235
+
+The miscellaneous information about the kanji
+
+***
+
+### readingMeaning
+
+> **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
+
+Defined in: types.ts:239
+
+The "readings-meanings" groups and nanori readings of the kanji

package/docs/api/interfaces/DictKanjiForm.md

@@ -0,0 +1,51 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiForm
+
+# Interface: DictKanjiForm
+
+Defined in: types.ts:16
+
+Word kanji form information
+
+Equivalent to the `k_ele` JMdict element
+
+## Properties
+
+### commonness?
+
+> `optional` **commonness**: `string`[]
+
+Defined in: types.ts:32
+
+Priority codes
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_freq](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_freq)
+
+***
+
+### form
+
+> `readonly` **form**: `string`
+
+Defined in: types.ts:20
+
+The kanji form of the word
+
+***
+
+### notes?
+
+> `optional` **notes**: `string`[]
+
+Defined in: types.ts:26
+
+Other information about the kanji form
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_kinf](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_kinf)

package/docs/api/interfaces/DictKanjiMisc.md

@@ -0,0 +1,61 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiMisc
+
+# Interface: DictKanjiMisc
+
+Defined in: types.ts:149
+
+Miscellaneous information about the kanji
+
+Equivalent to the `misc` KANJIDIC2 element *(excluding some subelements)*
+
+## Properties
+
+### frequency?
+
+> `optional` **frequency**: `string`
+
+Defined in: types.ts:169
+
+The frequency-of-use ranking
+
+A number from `1` to `2500`
+
+***
+
+### grade?
+
+> `optional` **grade**: `string`
+
+Defined in: types.ts:163
+
+The kanji grade level
+
+1-6 -> \[Kyōiku kanji\](https://en.wikipedia.org/wiki/Ky%C5%8Diku\_kanji)
+
+7-8 -> \[Jōyō kanji\](https://en.wikipedia.org/wiki/J%C5%8Dy%C5%8D\_kanji) (excluding Kyōiku kanji)
+
+9-10 -> \[Jinmeiyō kanji\](https://en.wikipedia.org/wiki/Jinmeiy%C5%8D\_kanji)
+
+***
+
+### jlpt?
+
+> `optional` **jlpt**: `string`
+
+Defined in: types.ts:173
+
+The \[pre-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Previous\_format\_(1984%E2%80%932009)) level
+
+***
+
+### strokeNumber
+
+> `readonly` **strokeNumber**: `string`
+
+Defined in: types.ts:153
+
+The stroke count of the kanji, including the radical

package/docs/api/interfaces/DictKanjiReading.md

@@ -0,0 +1,31 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiReading
+
+# Interface: DictKanjiReading
+
+Defined in: types.ts:179
+
+Kanji reading information
+
+## Properties
+
+### reading
+
+> `readonly` **reading**: `string`
+
+Defined in: types.ts:183
+
+The kanji reading (hiragana or katakana)
+
+***
+
+### type
+
+> **type**: `"ja_on"` \| `"ja_kun"`
+
+Defined in: types.ts:187
+
+The type of reading (onyomi or kunyomi)

package/docs/api/interfaces/DictKanjiReadingMeaning.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiReadingMeaning
+
+# Interface: DictKanjiReadingMeaning
+
+Defined in: types.ts:211
+
+Kanji "readings-meanings" groups and nanori readings
+
+Equivalent to the `reading_meaning` KANJIDIC2 element
+
+## Properties
+
+### groups
+
+> **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
+
+Defined in: types.ts:215
+
+The Kanji "readings-meanings" pairs
+
+***
+
+### nanori?
+
+> `optional` **nanori**: `string`[]
+
+Defined in: types.ts:219
+
+The kanji nanori readings

package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiReadingMeaningGroup
+
+# Interface: DictKanjiReadingMeaningGroup
+
+Defined in: types.ts:195
+
+Kanji "readings-meanings" pair
+
+Equivalent to the `rmgroup` KANJIDIC2 element
+
+## Properties
+
+### meanings
+
+> **meanings**: `string`[]
+
+Defined in: types.ts:203
+
+The kanji meanings
+
+***
+
+### readings
+
+> **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
+
+Defined in: types.ts:199
+
+The kanji readings

package/docs/api/interfaces/DictKanjiWithRadicals.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictKanjiWithRadicals
+
+# Interface: DictKanjiWithRadicals
+
+Defined in: types.ts:263
+
+KRADFILE2 entry (kanji with its radicals/components)
+
+## Properties
+
+### kanji
+
+> `readonly` **kanji**: `string`
+
+Defined in: types.ts:267
+
+The kanji character
+
+***
+
+### radicals
+
+> **radicals**: (`string` \| [`DictKanji`](DictKanji.md))[]
+
+Defined in: types.ts:273
+
+The radicals/components that make up the kanji
+
+Can be [DictKanji](DictKanji.md) objects if the component is a kanji found in KANJIDIC and/or [Kana.kana](Kana.md#kana) if the component is a katakana character that does not use (or have) its (or a) kanji variant.

package/docs/api/interfaces/DictMeaning.md

@@ -0,0 +1,129 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictMeaning
+
+# Interface: DictMeaning
+
+Defined in: types.ts:67
+
+Word meaning/sense information
+
+Equivalent to the `sense` JMdict element
+
+## Properties
+
+### antonyms?
+
+> `optional` **antonyms**: `string`[]
+
+Defined in: types.ts:95
+
+References to antonyms of the word *(when used with this meaning)*
+
+***
+
+### dialects?
+
+> `optional` **dialects**: `string`[]
+
+Defined in: types.ts:117
+
+Regional dialects the meaning is restricted to
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_dial](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_dial)
+
+***
+
+### fields?
+
+> `optional` **fields**: `string`[]
+
+Defined in: types.ts:101
+
+Field of application of the word *(when used with this meaning)*
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_fld](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_fld)
+
+***
+
+### info?
+
+> `optional` **info**: `string`[]
+
+Defined in: types.ts:105
+
+Additional information about the meaning
+
+***
+
+### kanjiFormRestrictions?
+
+> `optional` **kanjiFormRestrictions**: `string`[]
+
+Defined in: types.ts:87
+
+Kanji forms the meaning is restricted to
+
+***
+
+### misc?
+
+> `optional` **misc**: `string`[]
+
+Defined in: types.ts:111
+
+Other relevant information about the meaning
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_misc](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_misc)
+
+***
+
+### partOfSpeech?
+
+> `optional` **partOfSpeech**: `string`[]
+
+Defined in: types.ts:73
+
+Part of speech information
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_pos](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_pos)
+
+***
+
+### readingRestrictions?
+
+> `optional` **readingRestrictions**: `string`[]
+
+Defined in: types.ts:91
+
+Readings the meaning is restricted to
+
+***
+
+### references?
+
+> `optional` **references**: `string`[]
+
+Defined in: types.ts:83
+
+Cross-references to other similar/related words *(when used with this meaning)*
+
+***
+
+### translations?
+
+> `optional` **translations**: (`string` \| \{ `translation`: `string`; `type`: `"lit"` \| `"expl"` \| `"tm"`; \})[]
+
+Defined in: types.ts:77
+
+Word glosses

package/docs/api/interfaces/DictRadical.md

@@ -0,0 +1,41 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictRadical
+
+# Interface: DictRadical
+
+Defined in: types.ts:245
+
+RADKFILE2 entry (radical)
+
+## Properties
+
+### kanji
+
+> **kanji**: [`DictKanji`](DictKanji.md)[]
+
+Defined in: types.ts:253
+
+The kanji that include the radical
+
+***
+
+### radical
+
+> `readonly` **radical**: `string`
+
+Defined in: types.ts:249
+
+The radical character
+
+***
+
+### strokes
+
+> **strokes**: `string`
+
+Defined in: types.ts:257
+
+The stroke count of the radical

package/docs/api/interfaces/DictReading.md

@@ -0,0 +1,61 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictReading
+
+# Interface: DictReading
+
+Defined in: types.ts:40
+
+Word reading information
+
+Equivalent to the `r_ele` JMdict element
+
+## Properties
+
+### commonness?
+
+> `optional` **commonness**: `string`[]
+
+Defined in: types.ts:56
+
+Priority codes
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_freq](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_freq)
+
+***
+
+### kanjiFormRestrictions?
+
+> `optional` **kanjiFormRestrictions**: `string`[]
+
+Defined in: types.ts:60
+
+Kanji forms the reading is restricted to
+
+***
+
+### notes?
+
+> `optional` **notes**: `string`[]
+
+Defined in: types.ts:50
+
+Other information about the reading
+
+#### See
+
+[https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw\_rinf](https://www.edrdg.org/jmwsgi/edhelp.py?svc=jmdict#kw_rinf)
+
+***
+
+### reading
+
+> `readonly` **reading**: `string`
+
+Defined in: types.ts:44
+
+The reading of the word