henkan 2.1.0 → 2.2.0

package/docs/api/functions/isStringArray.md

@@ -8,7 +8,7 @@
 
 > **isStringArray**(`arg`): `arg is string[]`
 
-Defined in: [utils.ts:75](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L75)
+Defined in: [utils.ts:82](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L82)
 
 Checks if the argument is an array of strings.
 

package/docs/api/functions/isValidArrayWithFirstElement.md

@@ -8,7 +8,7 @@
 
 > **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
 
-Defined in: [utils.ts:66](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L66)
+Defined in: [utils.ts:73](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L73)
 
 Checks if the argument is an array and has at least one element.
 

package/docs/api/functions/shuffleArray.md

@@ -8,7 +8,7 @@
 
 > **shuffleArray**\<`T`\>(`arr`): `T`[]
 
-Defined in: [utils.ts:99](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L99)
+Defined in: [utils.ts:106](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L106)
 
 Shuffles an array using the `Fisher–Yates shuffle` algorithm
 

package/docs/api/interfaces/DefaultNoteInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: DefaultNoteInfo
 
-Defined in: [types.ts:910](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L910)
+Defined in: [types.ts:965](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L965)
 
 Default note ID, note type and deck name of a note
 
@@ -24,7 +24,7 @@ Setting any of the properties to:
 
 > `optional` **deckPath**: `string` \| `true`
 
-Defined in: [types.ts:924](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L924)
+Defined in: [types.ts:979](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L979)
 
 A default for [Result.deckPath](Grammar.md#deckpath)
 
@@ -34,7 +34,7 @@ A default for [Result.deckPath](Grammar.md#deckpath)
 
 > `optional` **guid**: `true` \| `"main_information"`
 
-Defined in: [types.ts:916](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L916)
+Defined in: [types.ts:971](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L971)
 
 A default for [Result.noteID](Grammar.md#noteid)
 
@@ -46,6 +46,6 @@ A default for [Result.noteID](Grammar.md#noteid)
 
 > `optional` **noteType**: `string` \| `true`
 
-Defined in: [types.ts:920](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L920)
+Defined in: [types.ts:975](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L975)
 
 A default for [Result.noteTypeName](Grammar.md#notetypename)

package/docs/api/interfaces/Definition.md

@@ -6,7 +6,7 @@
 
 # Interface: Definition
 
-Defined in: [types.ts:478](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L478)
+Defined in: [types.ts:533](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L533)
 
 A word definition
 
@@ -16,7 +16,7 @@ A word definition
 
 > **definition**: `string`
 
-Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L482)
+Defined in: [types.ts:537](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L537)
 
 The definition
 
@@ -26,7 +26,7 @@ The definition
 
 > `optional` **furigana**: `string`
 
-Defined in: [types.ts:486](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L486)
+Defined in: [types.ts:541](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L541)
 
 The definition with furigana attached
 
@@ -36,6 +36,6 @@ The definition with furigana attached
 
 > `optional` **mayNotBeAccurate**: `true`
 
-Defined in: [types.ts:490](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L490)
+Defined in: [types.ts:545](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L545)
 
 Whether or not the definition is associated with other words

package/docs/api/interfaces/EntryMaps.md

@@ -0,0 +1,83 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / EntryMaps
+
+# Interface: EntryMaps
+
+Defined in: [types.ts:470](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L470)
+
+Maps with various entry associations
+
+## Properties
+
+### kanjiEntryMap?
+
+> `optional` **kanjiEntryMap**: [`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md)
+
+Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L482)
+
+#### See
+
+[KanjiEntryMap](../type-aliases/KanjiEntryMap.md)
+
+***
+
+### kanjiSVGMap?
+
+> `optional` **kanjiSVGMap**: [`KanjiSVGMap`](../type-aliases/KanjiSVGMap.md)
+
+Defined in: [types.ts:494](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L494)
+
+#### See
+
+[KanjiSVGMap](../type-aliases/KanjiSVGMap.md)
+
+***
+
+### kanjiWordsMap?
+
+> `optional` **kanjiWordsMap**: [`KanjiWordsMap`](../type-aliases/KanjiWordsMap.md)
+
+Defined in: [types.ts:478](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L478)
+
+#### See
+
+[KanjiWordsMap](../type-aliases/KanjiWordsMap.md)
+
+***
+
+### wordDefinitionsMap?
+
+> `optional` **wordDefinitionsMap**: [`WordDefinitionsMap`](../type-aliases/WordDefinitionsMap.md)
+
+Defined in: [types.ts:490](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L490)
+
+#### See
+
+[WordDefinitionsMap](../type-aliases/WordDefinitionsMap.md)
+
+***
+
+### wordExamplesMap?
+
+> `optional` **wordExamplesMap**: [`WordExamplesMap`](../type-aliases/WordExamplesMap.md)
+
+Defined in: [types.ts:486](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L486)
+
+#### See
+
+[WordExamplesMap](../type-aliases/WordExamplesMap.md)
+
+***
+
+### wordIDEntryMap?
+
+> `optional` **wordIDEntryMap**: [`WordIDEntryMap`](../type-aliases/WordIDEntryMap.md)
+
+Defined in: [types.ts:474](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L474)
+
+#### See
+
+[WordIDEntryMap](../type-aliases/WordIDEntryMap.md)

package/docs/api/interfaces/Grammar.md

@@ -6,7 +6,7 @@
 
 # Interface: Grammar
 
-Defined in: [types.ts:858](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L858)
+Defined in: [types.ts:913](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L913)
 
 Grammar point information
 
@@ -20,7 +20,7 @@ Grammar point information
 
 > `optional` **audio**: `string`
 
-Defined in: [types.ts:890](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L890)
+Defined in: [types.ts:945](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L945)
 
 The filename of an audio file for the grammar point
 
@@ -30,7 +30,7 @@ The filename of an audio file for the grammar point
 
 > `optional` **deckPath**: `string`
 
-Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L542)
+Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
 
 The full path of the Anki deck
 
@@ -44,7 +44,7 @@ The full path of the Anki deck
 
 > `optional` **doNotCreateNote**: `true`
 
-Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L550)
+Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
 
 Whether or not this entry should be converted into an Anki note
 
@@ -58,7 +58,7 @@ Whether or not this entry should be converted into an Anki note
 
 > `optional` **id**: `` `${number}` ``
 
-Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L534)
+Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
 
 ID used for the Anki note ID
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
 
 > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
 
-Defined in: [types.ts:882](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L882)
+Defined in: [types.ts:937](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L937)
 
 The [post-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Test_format) level
 
@@ -82,7 +82,7 @@ The [post-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency
 
 > **meaning**: [`GrammarMeaning`](GrammarMeaning.md)
 
-Defined in: [types.ts:866](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L866)
+Defined in: [types.ts:921](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L921)
 
 The English meaning/translation of the grammar point
 
@@ -92,7 +92,7 @@ The English meaning/translation of the grammar point
 
 > `optional` **noteID**: `string`
 
-Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L530)
+Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
 
 ID used for the resulting Anki note
 
@@ -106,7 +106,7 @@ ID used for the resulting Anki note
 
 > `optional` **noteTypeName**: `string`
 
-Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L538)
+Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
 
 Anki note type name
 
@@ -120,7 +120,7 @@ Anki note type name
 
 > `optional` **phrases**: [`Phrase`](Phrase.md)[]
 
-Defined in: [types.ts:878](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L878)
+Defined in: [types.ts:933](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L933)
 
 Example phrase using the grammar point
 
@@ -130,7 +130,7 @@ Example phrase using the grammar point
 
 > `readonly` **point**: `string`
 
-Defined in: [types.ts:862](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L862)
+Defined in: [types.ts:917](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L917)
 
 The most common form in which the grammar point written in
 
@@ -140,7 +140,7 @@ The most common form in which the grammar point written in
 
 > `optional` **readings**: [`Reading`](Reading.md)[]
 
-Defined in: [types.ts:870](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L870)
+Defined in: [types.ts:925](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L925)
 
 The readings of the grammar point
 
@@ -150,7 +150,7 @@ The readings of the grammar point
 
 > `optional` **source**: `string`
 
-Defined in: [types.ts:886](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L886)
+Defined in: [types.ts:941](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L941)
 
 The source from which data for this grammar point has been extracted
 
@@ -160,7 +160,7 @@ The source from which data for this grammar point has been extracted
 
 > `optional` **tags**: `string`[]
 
-Defined in: [types.ts:546](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L546)
+Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
 
 Tags generated based on the entry's information
 
@@ -174,6 +174,6 @@ Tags generated based on the entry's information
 
 > `optional` **usages**: `string`[]
 
-Defined in: [types.ts:874](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L874)
+Defined in: [types.ts:929](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L929)
 
 Ways in which the grammar point is used in Japanese

package/docs/api/interfaces/GrammarMeaning.md

@@ -6,7 +6,7 @@
 
 # Interface: GrammarMeaning
 
-Defined in: [types.ts:844](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L844)
+Defined in: [types.ts:899](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L899)
 
 Grammar point meaning
 
@@ -16,7 +16,7 @@ Grammar point meaning
 
 > `optional` **example**: `string`
 
-Defined in: [types.ts:852](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L852)
+Defined in: [types.ts:907](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L907)
 
 An example phrase using the grammar point
 
@@ -26,6 +26,6 @@ An example phrase using the grammar point
 
 > **meaning**: `string`
 
-Defined in: [types.ts:848](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L848)
+Defined in: [types.ts:903](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L903)
 
 The meaning of the grammar point

package/docs/api/interfaces/JaWiktionaryEntry.md

@@ -6,7 +6,7 @@
 
 # Interface: JaWiktionaryEntry
 
-Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L456)
+Defined in: [types.ts:511](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L511)
 
 Useful information from a `ja.wiktionary.org` entry
 
@@ -16,7 +16,7 @@ Useful information from a `ja.wiktionary.org` entry
 
 > `optional` **forms**: `string`[]
 
-Defined in: [types.ts:472](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L472)
+Defined in: [types.ts:527](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L527)
 
 Other forms (as kanji form or kana) of the word
 
@@ -26,7 +26,7 @@ Other forms (as kanji form or kana) of the word
 
 > `optional` **pos\_title**: [`POS`](../type-aliases/POS.md)
 
-Defined in: [types.ts:464](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L464)
+Defined in: [types.ts:519](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L519)
 
 The part of speech (in Japanese)
 
@@ -36,7 +36,7 @@ The part of speech (in Japanese)
 
 > **senses**: `JaWiktionaryEntrySense`[]
 
-Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L468)
+Defined in: [types.ts:523](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L523)
 
 The word senses
 
@@ -46,6 +46,6 @@ The word senses
 
 > **word**: `string`
 
-Defined in: [types.ts:460](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L460)
+Defined in: [types.ts:515](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L515)
 
 The "title" (word) of the page

package/docs/api/interfaces/Kana.md

@@ -6,7 +6,7 @@
 
 # Interface: Kana
 
-Defined in: [types.ts:822](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L822)
+Defined in: [types.ts:877](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L877)
 
 Kana information
 
@@ -20,7 +20,7 @@ Kana information
 
 > `optional` **audio**: `string`
 
-Defined in: [types.ts:834](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L834)
+Defined in: [types.ts:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
 
 The filename of an audio file for the kana reading
 
@@ -30,7 +30,7 @@ The filename of an audio file for the kana reading
 
 > `optional` **deckPath**: `string`
 
-Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L542)
+Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
 
 The full path of the Anki deck
 
@@ -44,7 +44,7 @@ The full path of the Anki deck
 
 > `optional` **doNotCreateNote**: `true`
 
-Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L550)
+Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
 
 Whether or not this entry should be converted into an Anki note
 
@@ -58,7 +58,7 @@ Whether or not this entry should be converted into an Anki note
 
 > `optional` **id**: `` `${number}` ``
 
-Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L534)
+Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
 
 ID used for the Anki note ID
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
 
 > `readonly` **kana**: `string`
 
-Defined in: [types.ts:826](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L826)
+Defined in: [types.ts:881](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L881)
 
 The kana character
 
@@ -82,7 +82,7 @@ The kana character
 
 > `optional` **noteID**: `string`
 
-Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L530)
+Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
 
 ID used for the resulting Anki note
 
@@ -96,7 +96,7 @@ ID used for the resulting Anki note
 
 > `optional` **noteTypeName**: `string`
 
-Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L538)
+Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
 
 Anki note type name
 
@@ -110,7 +110,7 @@ Anki note type name
 
 > **reading**: `string`
 
-Defined in: [types.ts:830](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L830)
+Defined in: [types.ts:885](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L885)
 
 The romaji reading of the kana
 
@@ -120,7 +120,7 @@ The romaji reading of the kana
 
 > `optional` **svg**: `string`
 
-Defined in: [types.ts:838](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L838)
+Defined in: [types.ts:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
 
 The kana SVG filename
 
@@ -130,7 +130,7 @@ The kana SVG filename
 
 > `optional` **tags**: `string`[]
 
-Defined in: [types.ts:546](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L546)
+Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
 
 Tags generated based on the entry's information