henkan 2.4.12 → 3.0.1

package/docs/api/interfaces/EntryMaps.md

@@ -6,7 +6,7 @@
 
 # Interface: EntryMaps
 
-Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L468)
+Defined in: [types.ts:522](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L522)
 
 Maps with various entry associations
 
@@ -16,7 +16,7 @@ Maps with various entry associations
 
 > `optional` **kanjiEntryMap**: [`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md)
 
-Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L480)
+Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L538)
 
 #### See
 
@@ -28,7 +28,7 @@ Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **kanjiSVGMap**: [`KanjiSVGMap`](../type-aliases/KanjiSVGMap.md)
 
-Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L492)
+Defined in: [types.ts:554](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L554)
 
 #### See
 
@@ -40,7 +40,7 @@ Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **kanjiWordsMap**: [`KanjiWordsMap`](../type-aliases/KanjiWordsMap.md)
 
-Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L476)
+Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L534)
 
 #### See
 
@@ -48,11 +48,35 @@ Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 ***
 
+### nameExamplesMap?
+
+> `optional` **nameExamplesMap**: [`EntryExamplesMap`](../type-aliases/EntryExamplesMap.md)
+
+Defined in: [types.ts:546](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L546)
+
+#### See
+
+[EntryExamplesMap](../type-aliases/EntryExamplesMap.md)
+
+***
+
+### nameIDEntryMap?
+
+> `optional` **nameIDEntryMap**: [`NameIDEntryMap`](../type-aliases/NameIDEntryMap.md)
+
+Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L530)
+
+#### See
+
+[NameIDEntryMap](../type-aliases/NameIDEntryMap.md)
+
+***
+
 ### wordDefinitionsMap?
 
 > `optional` **wordDefinitionsMap**: [`WordDefinitionsMap`](../type-aliases/WordDefinitionsMap.md)
 
-Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L488)
+Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L550)
 
 #### See
 
@@ -62,13 +86,13 @@ Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 ### wordExamplesMap?
 
-> `optional` **wordExamplesMap**: [`WordExamplesMap`](../type-aliases/WordExamplesMap.md)
+> `optional` **wordExamplesMap**: [`EntryExamplesMap`](../type-aliases/EntryExamplesMap.md)
 
-Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L484)
+Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L542)
 
 #### See
 
-[WordExamplesMap](../type-aliases/WordExamplesMap.md)
+[EntryExamplesMap](../type-aliases/EntryExamplesMap.md)
 
 ***
 
@@ -76,7 +100,7 @@ Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **wordIDEntryMap**: [`WordIDEntryMap`](../type-aliases/WordIDEntryMap.md)
 
-Defined in: [types.ts:472](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L472)
+Defined in: [types.ts:526](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L526)
 
 #### See
 

package/docs/api/interfaces/ExamplePart.md

@@ -6,7 +6,7 @@
 
 # Interface: ExamplePart
 
-Defined in: [types.ts:363](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L363)
+Defined in: [types.ts:413](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L413)
 
 A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
 
@@ -16,7 +16,7 @@ A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
 
 > **baseForm**: `string`
 
-Defined in: [types.ts:367](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L367)
+Defined in: [types.ts:417](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L417)
 
 The common form in which the word is found in JMdict
 
@@ -26,7 +26,7 @@ The common form in which the word is found in JMdict
 
 > `optional` **edited**: `true`
 
-Defined in: [types.ts:391](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L391)
+Defined in: [types.ts:441](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L441)
 
 Whether or not the word is part of an entry that has been edited and adapted
 
@@ -40,7 +40,7 @@ Whether or not the word is part of an entry that has been edited and adapted
 
 > `optional` **glossNumber**: `number`
 
-Defined in: [types.ts:375](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L375)
+Defined in: [types.ts:425](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L425)
 
 The JMdict sense number corresponding to the word’s usage in the phrase
 
@@ -50,7 +50,7 @@ The JMdict sense number corresponding to the word’s usage in the phrase
 
 > `optional` **inflectedForm**: `string`
 
-Defined in: [types.ts:379](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L379)
+Defined in: [types.ts:429](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L429)
 
 The actual form in which the word is used in the phrase
 
@@ -60,7 +60,7 @@ The actual form in which the word is used in the phrase
 
 > `optional` **reading**: `string`
 
-Defined in: [types.ts:371](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L371)
+Defined in: [types.ts:421](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L421)
 
 The reading (in kana) of the word
 
@@ -70,6 +70,6 @@ The reading (in kana) of the word
 
 > `optional` **referenceID**: `` `${number}` ``
 
-Defined in: [types.ts:383](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L383)
+Defined in: [types.ts:433](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L433)
 
 A sequence number that references a JMdict entry associated with the word

package/docs/api/interfaces/GlossSpecificNumber.md

@@ -6,7 +6,7 @@
 
 # Interface: GlossSpecificNumber
 
-Defined in: [types.ts:397](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L397)
+Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
 
 A pair of a word ID and a number associated with a gloss number
 
@@ -16,7 +16,7 @@ A pair of a word ID and a number associated with a gloss number
 
 > `readonly` **glossNumber**: `number`
 
-Defined in: [types.ts:405](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L405)
+Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
 
 The entry's gloss number
 
@@ -26,6 +26,6 @@ The entry's gloss number
 
 > `readonly` **wordId**: `` `${number}` ``
 
-Defined in: [types.ts:401](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L401)
+Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
 
 The entry ID

package/docs/api/interfaces/Grammar.md

@@ -6,7 +6,7 @@
 
 # Interface: Grammar
 
-Defined in: [types.ts:921](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L921)
+Defined in: [types.ts:1021](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1021)
 
 Grammar point information
 
@@ -20,7 +20,7 @@ Grammar point information
 
 > `optional` **audio**: `string`
 
-Defined in: [types.ts:953](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L953)
+Defined in: [types.ts:1053](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1053)
 
 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:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
+Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L673)
 
 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:613](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L613)
+Defined in: [types.ts:681](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L681)
 
 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:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
+Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L665)
 
 ID used for the Anki note ID
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
 
 > `optional` **jlpt**: `` `N${number}` ``
 
-Defined in: [types.ts:945](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L945)
+Defined in: [types.ts:1045](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1045)
 
 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:929](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L929)
+Defined in: [types.ts:1029](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1029)
 
 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:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
+Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L661)
 
 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:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
+Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L669)
 
 Anki note type name
 
@@ -120,7 +120,7 @@ Anki note type name
 
 > `optional` **phrases**: [`Phrase`](Phrase.md)[]
 
-Defined in: [types.ts:941](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L941)
+Defined in: [types.ts:1041](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1041)
 
 Example phrase using the grammar point
 
@@ -130,7 +130,7 @@ Example phrase using the grammar point
 
 > `readonly` **point**: `string`
 
-Defined in: [types.ts:925](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L925)
+Defined in: [types.ts:1025](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1025)
 
 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:933](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L933)
+Defined in: [types.ts:1033](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1033)
 
 The readings of the grammar point
 
@@ -150,7 +150,7 @@ The readings of the grammar point
 
 > `optional` **source**: `string`
 
-Defined in: [types.ts:949](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L949)
+Defined in: [types.ts:1049](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1049)
 
 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:609](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L609)
+Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L677)
 
 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:937](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L937)
+Defined in: [types.ts:1037](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1037)
 
 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:907](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L907)
+Defined in: [types.ts:1007](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1007)
 
 Grammar point meaning
 
@@ -16,7 +16,7 @@ Grammar point meaning
 
 > `optional` **example**: `string`
 
-Defined in: [types.ts:915](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L915)
+Defined in: [types.ts:1015](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1015)
 
 An example phrase using the grammar point
 
@@ -26,6 +26,6 @@ An example phrase using the grammar point
 
 > **meaning**: `string`
 
-Defined in: [types.ts:911](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L911)
+Defined in: [types.ts:1011](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1011)
 
 The meaning of the grammar point

package/docs/api/interfaces/JaWiktionaryEntry.md

@@ -6,7 +6,7 @@
 
 # Interface: JaWiktionaryEntry
 
-Defined in: [types.ts:509](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L509)
+Defined in: [types.ts:571](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L571)
 
 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:525](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L525)
+Defined in: [types.ts:587](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L587)
 
 Other forms (as kanji form or kana) of the word
 
@@ -26,7 +26,7 @@ Other forms (as kanji form or kana) of the word
 
 > **pos\_title**: [`POS`](../type-aliases/POS.md)
 
-Defined in: [types.ts:517](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L517)
+Defined in: [types.ts:579](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L579)
 
 The part of speech (in Japanese)
 
@@ -36,7 +36,7 @@ The part of speech (in Japanese)
 
 > `optional` **senses**: `JaWiktionaryEntrySense`[]
 
-Defined in: [types.ts:521](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L521)
+Defined in: [types.ts:583](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L583)
 
 The word senses
 
@@ -46,6 +46,6 @@ The word senses
 
 > **word**: `string`
 
-Defined in: [types.ts:513](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L513)
+Defined in: [types.ts:575](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L575)
 
 The "title" (word) of the page

package/docs/api/interfaces/Kana.md

@@ -6,7 +6,7 @@
 
 # Interface: Kana
 
-Defined in: [types.ts:885](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L885)
+Defined in: [types.ts:985](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L985)
 
 Kana information
 
@@ -20,7 +20,7 @@ Kana information
 
 > `optional` **audio**: `string`
 
-Defined in: [types.ts:897](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L897)
+Defined in: [types.ts:997](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L997)
 
 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:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
+Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L673)
 
 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:613](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L613)
+Defined in: [types.ts:681](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L681)
 
 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:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
+Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L665)
 
 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:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
+Defined in: [types.ts:989](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L989)
 
 The kana character
 
@@ -82,7 +82,7 @@ The kana character
 
 > `optional` **noteID**: `string`
 
-Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
+Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L661)
 
 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:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
+Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L669)
 
 Anki note type name
 
@@ -110,7 +110,7 @@ Anki note type name
 
 > **reading**: `string`
 
-Defined in: [types.ts:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
+Defined in: [types.ts:993](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L993)
 
 The romaji reading of the kana
 
@@ -120,7 +120,7 @@ The romaji reading of the kana
 
 > `optional` **svg**: `string`
 
-Defined in: [types.ts:901](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L901)
+Defined in: [types.ts:1001](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1001)
 
 The kana SVG filename
 
@@ -130,7 +130,7 @@ The kana SVG filename
 
 > `optional` **tags**: `string`[]
 
-Defined in: [types.ts:609](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L609)
+Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L677)
 
 Tags generated based on the entry's information