henkan 0.0.0

package/docs/api/interfaces/DictWord.md

@@ -0,0 +1,53 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DictWord
+
+# Interface: DictWord
+
+Defined in: types.ts:125
+
+JMdict entry (word)
+
+Equivalent to the `entry` JMdict element
+
+## Properties
+
+### id
+
+> `readonly` **id**: `string`
+
+Defined in: types.ts:129
+
+The entry sequence number
+
+***
+
+### kanjiForms?
+
+> `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
+
+Defined in: types.ts:133
+
+The word's kanji forms
+
+***
+
+### meanings
+
+> **meanings**: [`DictMeaning`](DictMeaning.md)[]
+
+Defined in: types.ts:141
+
+The word's meanings/senses
+
+***
+
+### readings
+
+> **readings**: [`DictReading`](DictReading.md)[]
+
+Defined in: types.ts:137
+
+The word's readings

package/docs/api/interfaces/ExamplePart.md

@@ -0,0 +1,75 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / ExamplePart
+
+# Interface: ExamplePart
+
+Defined in: types.ts:279
+
+A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
+
+## Properties
+
+### baseForm
+
+> **baseForm**: `string`
+
+Defined in: types.ts:283
+
+The common form in which the word is found in JMdict
+
+***
+
+### edited?
+
+> `optional` **edited**: `true`
+
+Defined in: types.ts:307
+
+Whether or not the word is part of an entry that has been edited and adapted
+
+[https://www.edrdg.org/wiki/Tanaka\_Corpus.html#Subset](https://www.edrdg.org/wiki/Tanaka_Corpus.html#Subset)
+
+[https://www.edrdg.org/wiki/Tanaka\_Corpus.html#Initial\_Modifications\_to\_the\_Corpus](https://www.edrdg.org/wiki/Tanaka_Corpus.html#Initial_Modifications_to_the_Corpus)
+
+***
+
+### glossNumber?
+
+> `optional` **glossNumber**: `number`
+
+Defined in: types.ts:291
+
+The JMdict sense number corresponding to the word’s usage in the phrase
+
+***
+
+### inflectedForm?
+
+> `optional` **inflectedForm**: `string`
+
+Defined in: types.ts:295
+
+The actual form in which the word is used in the phrase
+
+***
+
+### reading?
+
+> `optional` **reading**: `string`
+
+Defined in: types.ts:287
+
+The reading (in kana) of the word
+
+***
+
+### referenceID?
+
+> `optional` **referenceID**: `string`
+
+Defined in: types.ts:299
+
+A sequence number that references a JMdict entry associated with the word

package/docs/api/interfaces/Grammar.md

@@ -0,0 +1,165 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Grammar
+
+# Interface: Grammar
+
+Defined in: types.ts:634
+
+Grammar point information
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"grammar"`\>
+
+## Properties
+
+### audio?
+
+> `optional` **audio**: `string`
+
+Defined in: types.ts:666
+
+The filename of an audio file for the grammar point
+
+***
+
+### 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)
+
+***
+
+### jlpt?
+
+> `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
+
+Defined in: types.ts:658
+
+The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Test\_format) level
+
+***
+
+### meaning
+
+> **meaning**: [`GrammarMeaning`](GrammarMeaning.md)
+
+Defined in: types.ts:642
+
+The English meaning/translation of the grammar point
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `grammar_${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:654
+
+Example phrase using the grammar point
+
+***
+
+### point
+
+> `readonly` **point**: `string`
+
+Defined in: types.ts:638
+
+The most common form in which the grammar point written in
+
+***
+
+### readings?
+
+> `optional` **readings**: [`Reading`](Reading.md)[]
+
+Defined in: types.ts:646
+
+The readings of the grammar point
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+Defined in: types.ts:662
+
+The source from which data for this grammar point has been extracted
+
+***
+
+### 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)
+
+***
+
+### usages?
+
+> `optional` **usages**: `string`[]
+
+Defined in: types.ts:650
+
+Ways in which the grammar point is used in Japanese

package/docs/api/interfaces/GrammarMeaning.md

@@ -0,0 +1,31 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / GrammarMeaning
+
+# Interface: GrammarMeaning
+
+Defined in: types.ts:620
+
+Grammar point meaning
+
+## Properties
+
+### example?
+
+> `optional` **example**: `string`
+
+Defined in: types.ts:628
+
+An example phrase using the grammar point
+
+***
+
+### meaning
+
+> **meaning**: `string`
+
+Defined in: types.ts:624
+
+The meaning of the grammar point

package/docs/api/interfaces/Kana.md

@@ -0,0 +1,125 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Kana
+
+# Interface: Kana
+
+Defined in: types.ts:598
+
+Kana information
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"kana"`\>
+
+## Properties
+
+### audio?
+
+> `optional` **audio**: `string`
+
+Defined in: types.ts:610
+
+The filename of an audio file for the kana reading
+
+***
+
+### 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)
+
+***
+
+### kana
+
+> `readonly` **kana**: `string`
+
+Defined in: types.ts:602
+
+The kana character
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `kana_${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)
+
+***
+
+### reading
+
+> **reading**: `string`
+
+Defined in: types.ts:606
+
+The romaji reading of the kana
+
+***
+
+### svg?
+
+> `optional` **svg**: `string`
+
+Defined in: types.ts:614
+
+The kana 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/Kanji.md

@@ -0,0 +1,239 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Kanji
+
+# Interface: Kanji
+
+Defined in: types.ts:444
+
+Kanji information
+
+Converted from [DictKanji](DictKanji.md) and extra info added
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"kanji"`\>
+
+## Properties
+
+### components?
+
+> `optional` **components**: [`KanjiComponent`](KanjiComponent.md)[]
+
+Defined in: types.ts:476
+
+The kanji radicals/components
+
+***
+
+### 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)
+
+***
+
+### frequency?
+
+> `optional` **frequency**: `string`
+
+Defined in: types.ts:492
+
+#### See
+
+[DictKanjiMisc.frequency](DictKanjiMisc.md#frequency)
+
+***
+
+### fromJpdb?
+
+> `optional` **fromJpdb**: `true`
+
+Defined in: types.ts:500
+
+Whether or not this kanji object contains information **only** from `jpdb.io`
+
+***
+
+### grade?
+
+> `optional` **grade**: `string`
+
+Defined in: types.ts:488
+
+#### See
+
+[DictKanjiMisc.grade](DictKanjiMisc.md#grade)
+
+***
+
+### 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
+
+> `readonly` **kanji**: `string`
+
+Defined in: types.ts:448
+
+#### See
+
+[DictKanji.kanji](DictKanji.md#kanji)
+
+***
+
+### kunyomi?
+
+> `optional` **kunyomi**: `string`[]
+
+Defined in: types.ts:464
+
+The kanji kunyomi readings
+
+***
+
+### meanings?
+
+> `optional` **meanings**: `string`[]
+
+Defined in: types.ts:456
+
+#### See
+
+[DictKanjiReadingMeaningGroup.meanings](DictKanjiReadingMeaningGroup.md#meanings)
+
+***
+
+### mnemonic?
+
+> `optional` **mnemonic**: `string`
+
+Defined in: types.ts:480
+
+The kanji mnemonic
+
+***
+
+### nanori?
+
+> `optional` **nanori**: `string`[]
+
+Defined in: types.ts:468
+
+#### See
+
+[DictKanjiReadingMeaning.nanori](DictKanjiReadingMeaning.md#nanori)
+
+***
+
+### noteID?
+
+> `readonly` `optional` **noteID**: `` `kanji_${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)
+
+***
+
+### onyomi?
+
+> `optional` **onyomi**: `string`[]
+
+Defined in: types.ts:460
+
+The kanji onyomi readings
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+Defined in: types.ts:496
+
+The source (besides KANJIDIC) from which data for this kanji has been extracted
+
+***
+
+### strokes?
+
+> `optional` **strokes**: `string`
+
+Defined in: types.ts:452
+
+#### See
+
+[DictKanjiMisc.strokeNumber](DictKanjiMisc.md#strokenumber)
+
+***
+
+### svg?
+
+> `optional` **svg**: `string`
+
+Defined in: types.ts:472
+
+The kanji 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)
+
+***
+
+### words?
+
+> `optional` **words**: [`Word`](Word.md)[]
+
+Defined in: types.ts:484
+
+Words that use the kanji

package/docs/api/interfaces/KanjiComponent.md

@@ -0,0 +1,31 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / KanjiComponent
+
+# Interface: KanjiComponent
+
+Defined in: types.ts:428
+
+Kanji component information
+
+## Properties
+
+### component
+
+> `readonly` **component**: `string`
+
+Defined in: types.ts:432
+
+The component character
+
+***
+
+### meaning?
+
+> `optional` **meaning**: `string`
+
+Defined in: types.ts:436
+
+The meaning of the component