henkan 0.0.0

package/docs/api/interfaces/KanjiForm.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / KanjiForm
+
+# Interface: KanjiForm
+
+Defined in: types.ts:378
+
+A kanji form of the word
+
+Converted from a [DictKanjiForm](DictKanjiForm.md)
+
+## Properties
+
+### kanjiForm
+
+> `readonly` **kanjiForm**: `string`
+
+Defined in: types.ts:382
+
+The kanji form
+
+***
+
+### notes?
+
+> `optional` **notes**: `string`[]
+
+Defined in: types.ts:386
+
+Optional notes for the kanji form

package/docs/api/interfaces/Phrase.md

@@ -0,0 +1,47 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Phrase
+
+# Interface: Phrase
+
+Defined in: types.ts:546
+
+Phrase information
+
+Converted from [TanakaExample](TanakaExample.md)
+
+## Properties
+
+### originalPhrase
+
+> `readonly` **originalPhrase**: `string`
+
+Defined in: types.ts:558
+
+#### See
+
+[TanakaExample.phrase](TanakaExample.md#phrase)
+
+***
+
+### phrase
+
+> `readonly` **phrase**: `string`
+
+Defined in: types.ts:550
+
+The Japanese phrase, either with furigana attached or not
+
+***
+
+### translation
+
+> `readonly` **translation**: `string`
+
+Defined in: types.ts:554
+
+#### See
+
+[TanakaExample.translation](TanakaExample.md#translation)

package/docs/api/interfaces/Radical.md

@@ -0,0 +1,165 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Radical
+
+# Interface: Radical
+
+Defined in: types.ts:506
+
+Kanji radical/component information
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"radical"`\>
+
+## Properties
+
+### deckPath?
+
+> `optional` **deckPath**: `string`
+
+Defined in: types.ts:366
+
+The full path of the Anki deck
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`deckPath`](ResultEntry.md#deckpath)
+
+***
+
+### id?
+
+> `readonly` `optional` **id**: `string`
+
+Defined in: types.ts:358
+
+ID used for the Anki note ID
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`id`](ResultEntry.md#id)
+
+***
+
+### kanji?
+
+> `optional` **kanji**: [`Kanji`](Kanji.md)[]
+
+Defined in: types.ts:534
+
+Kanji that include the radical/component
+
+***
+
+### meanings
+
+> **meanings**: `string`[]
+
+Defined in: types.ts:518
+
+The radical/component meanings
+
+***
+
+### mnemonic?
+
+> `optional` **mnemonic**: `string`
+
+Defined in: types.ts:530
+
+The radical/component mnemonic
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `radical_${string}` ``
+
+Defined in: types.ts:354
+
+ID used for the resulting Anki note
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteID`](ResultEntry.md#noteid)
+
+***
+
+### noteTypeName?
+
+> `optional` **noteTypeName**: `string`
+
+Defined in: types.ts:362
+
+Anki note type name
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteTypeName`](ResultEntry.md#notetypename)
+
+***
+
+### radical
+
+> `readonly` **radical**: `string`
+
+Defined in: types.ts:510
+
+The radical/component character
+
+***
+
+### reading
+
+> **reading**: `string`
+
+Defined in: types.ts:514
+
+The radical/component reading (in kana)
+
+***
+
+### sources?
+
+> `optional` **sources**: `string`[]
+
+Defined in: types.ts:538
+
+The sources from which data for this radical/component has been extracted
+
+***
+
+### strokes?
+
+> `optional` **strokes**: `string`
+
+Defined in: types.ts:522
+
+The stroke count of the radical/component
+
+***
+
+### svg?
+
+> `optional` **svg**: `string`
+
+Defined in: types.ts:526
+
+The radical/component SVG filename
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: types.ts:370
+
+Tags generated based on the entry's information
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`tags`](ResultEntry.md#tags)

package/docs/api/interfaces/Reading.md

@@ -0,0 +1,43 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Reading
+
+# Interface: Reading
+
+Defined in: types.ts:394
+
+A reading of the word
+
+Converted from [DictReading](DictReading.md)
+
+## Properties
+
+### audio?
+
+> `optional` **audio**: `string`
+
+Defined in: types.ts:406
+
+The filename of an audio file for the reading
+
+***
+
+### notes?
+
+> `optional` **notes**: `string`[]
+
+Defined in: types.ts:402
+
+Optional notes for the reading
+
+***
+
+### reading
+
+> `readonly` **reading**: `string`
+
+Defined in: types.ts:398
+
+The reading (in kana)

package/docs/api/interfaces/ResultEntry.md

@@ -0,0 +1,75 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / ResultEntry
+
+# Interface: ResultEntry\<EntryType\>
+
+Defined in: types.ts:350
+
+Basic Anki note information
+
+## Extended by
+
+- [`Kanji`](Kanji.md)
+- [`Radical`](Radical.md)
+- [`Word`](Word.md)
+- [`Kana`](Kana.md)
+- [`Grammar`](Grammar.md)
+
+## Type Parameters
+
+### EntryType
+
+`EntryType` *extends* `string`
+
+## Properties
+
+### deckPath?
+
+> `optional` **deckPath**: `string`
+
+Defined in: types.ts:366
+
+The full path of the Anki deck
+
+***
+
+### id?
+
+> `readonly` `optional` **id**: `string`
+
+Defined in: types.ts:358
+
+ID used for the Anki note ID
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
+
+Defined in: types.ts:354
+
+ID used for the resulting Anki note
+
+***
+
+### noteTypeName?
+
+> `optional` **noteTypeName**: `string`
+
+Defined in: types.ts:362
+
+Anki note type name
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: types.ts:370
+
+Tags generated based on the entry's information

package/docs/api/interfaces/TanakaExample.md

@@ -0,0 +1,51 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / TanakaExample
+
+# Interface: TanakaExample
+
+Defined in: types.ts:313
+
+Tanaka Corpus `examples.utf` examples
+
+## Properties
+
+### furigana?
+
+> `optional` **furigana**: `string`
+
+Defined in: types.ts:329
+
+The Japanese phrase, with furigana attached
+
+***
+
+### parts
+
+> **parts**: [`ExamplePart`](ExamplePart.md)[]
+
+Defined in: types.ts:325
+
+The `B` section, split into parts
+
+***
+
+### phrase
+
+> **phrase**: `string`
+
+Defined in: types.ts:317
+
+The Japanese phrase (found in the `A` section, **before** the tab)
+
+***
+
+### translation
+
+> **translation**: `string`
+
+Defined in: types.ts:321
+
+The English translation of the phrase (found in the `A` section, **after** the tab)

package/docs/api/interfaces/Translation.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Translation
+
+# Interface: Translation
+
+Defined in: types.ts:414
+
+A translation of the word
+
+Converted from [DictMeaning](DictMeaning.md)
+
+## Properties
+
+### notes?
+
+> `optional` **notes**: `string`[]
+
+Defined in: types.ts:422
+
+Information about the translation
+
+***
+
+### translation
+
+> `readonly` **translation**: `string`
+
+Defined in: types.ts:418
+
+The translation

package/docs/api/interfaces/UsefulRegExps.md

@@ -0,0 +1,93 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / UsefulRegExps
+
+# Interface: UsefulRegExps
+
+Defined in: types.ts:677
+
+Some useful regular expressions
+
+## Properties
+
+### hiragana
+
+> `readonly` **hiragana**: `RegExp`
+
+Defined in: types.ts:681
+
+Matches any *hiragana* character(s)
+
+***
+
+### kanji
+
+> `readonly` **kanji**: `RegExp`
+
+Defined in: types.ts:689
+
+Matches any *kanji* character(s)
+
+***
+
+### katakana
+
+> `readonly` **katakana**: `RegExp`
+
+Defined in: types.ts:685
+
+Matches any *katakana* character(s)
+
+***
+
+### regExChars
+
+> `readonly` **regExChars**: `RegExp`
+
+Defined in: types.ts:699
+
+Matches any character that is part of the regex syntax
+
+***
+
+### scriptSplit
+
+> `readonly` **scriptSplit**: `RegExp`
+
+Defined in: types.ts:695
+
+Matches and splits Japanese expressions into different scripts
+
+Used when creating a SSML
+
+***
+
+### tanakaID
+
+> `readonly` **tanakaID**: `RegExp`
+
+Defined in: types.ts:703
+
+Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
+
+***
+
+### tanakaPart
+
+> `readonly` **tanakaPart**: `RegExp`
+
+Defined in: types.ts:707
+
+Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.utf` file
+
+***
+
+### tanakaReferenceID
+
+> `readonly` **tanakaReferenceID**: `RegExp`
+
+Defined in: types.ts:711
+
+Matches the reference ID element of a Tanaka example part

package/docs/api/interfaces/Word.md

@@ -0,0 +1,149 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Word
+
+# Interface: Word
+
+Defined in: types.ts:566
+
+Word information
+
+Converted from [DictWord](DictWord.md)
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"word"`\>
+
+## Properties
+
+### common?
+
+> `optional` **common**: `true`
+
+Defined in: types.ts:592
+
+Whether or not the word is common
+
+A word is considered *common* if the [DictWord.readings](DictWord.md#readings) and/or the [DictWord.kanjiForms](DictWord.md#kanjiforms) array(s) include(s) at least one element with the [DictReading.commonness](DictReading.md#commonness) or [DictKanjiForm.commonness](DictKanjiForm.md#commonness) property defined.
+
+***
+
+### deckPath?
+
+> `optional` **deckPath**: `string`
+
+Defined in: types.ts:366
+
+The full path of the Anki deck
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`deckPath`](ResultEntry.md#deckpath)
+
+***
+
+### id?
+
+> `readonly` `optional` **id**: `string`
+
+Defined in: types.ts:358
+
+ID used for the Anki note ID
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`id`](ResultEntry.md#id)
+
+***
+
+### kanji?
+
+> `optional` **kanji**: [`Kanji`](Kanji.md)[]
+
+Defined in: types.ts:582
+
+A list of kanji used in the kanji forms
+
+***
+
+### kanjiForms?
+
+> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
+
+Defined in: types.ts:578
+
+The word kanji forms
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `word_${string}` ``
+
+Defined in: types.ts:354
+
+ID used for the resulting Anki note
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteID`](ResultEntry.md#noteid)
+
+***
+
+### noteTypeName?
+
+> `optional` **noteTypeName**: `string`
+
+Defined in: types.ts:362
+
+Anki note type name
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteTypeName`](ResultEntry.md#notetypename)
+
+***
+
+### phrases?
+
+> `optional` **phrases**: [`Phrase`](Phrase.md)[]
+
+Defined in: types.ts:586
+
+Phrases associated to the word
+
+***
+
+### readings
+
+> **readings**: [`Reading`](Reading.md)[]
+
+Defined in: types.ts:570
+
+The word readings (in kana)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: types.ts:370
+
+Tags generated based on the entry's information
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`tags`](ResultEntry.md#tags)
+
+***
+
+### translations?
+
+> `optional` **translations**: [`Translation`](Translation.md)[]
+
+Defined in: types.ts:574
+
+The word translations/senses

package/docs/api/type-aliases/Dict.md

@@ -0,0 +1,13 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Dict
+
+# Type Alias: Dict
+
+> **Dict** = [`DictWord`](../interfaces/DictWord.md)[] \| [`DictKanji`](../interfaces/DictKanji.md)[] \| [`TanakaExample`](../interfaces/TanakaExample.md)[] \| [`DictRadical`](../interfaces/DictRadical.md)[] \| [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
+
+Defined in: types.ts:335
+
+Any type of entry list

package/docs/api/type-aliases/DictName.md

@@ -0,0 +1,13 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictName
+
+# Type Alias: DictName
+
+> **DictName** = `"JMDict"` \| `"Kanjidic"` \| `"tanaka"` \| `"radk"` \| `"krad"`
+
+Defined in: types.ts:9
+
+Standardized dictionary names