henkan 2.4.12 → 3.0.1

package/docs/api/interfaces/Kanji.md

@@ -6,7 +6,7 @@
 
 # Interface: Kanji
 
-Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L709)
+Defined in: [types.ts:777](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L777)
 
 Kanji information
 
@@ -22,7 +22,7 @@ Converted from [DictKanji](DictKanji.md) and extra info added
 
 > `optional` **components**: [`KanjiComponent`](KanjiComponent.md)[]
 
-Defined in: [types.ts:741](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L741)
+Defined in: [types.ts:809](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L809)
 
 The kanji radicals/components
 
@@ -32,7 +32,7 @@ The kanji radicals/components
 
 > `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
 
@@ -46,7 +46,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
 
@@ -60,7 +60,7 @@ Whether or not this entry should be converted into an Anki note
 
 > `optional` **externalInfo**: `true`
 
-Defined in: [types.ts:773](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L773)
+Defined in: [types.ts:841](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L841)
 
 Whether or not this kanji object contains information extracted from [source](#source)
 
@@ -70,7 +70,7 @@ Whether or not this kanji object contains information extracted from [source](#s
 
 > `optional` **frequency**: `string`
 
-Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L757)
+Defined in: [types.ts:825](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L825)
 
 #### See
 
@@ -82,7 +82,7 @@ Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **grade**: `string`
 
-Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L753)
+Defined in: [types.ts:821](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L821)
 
 #### See
 
@@ -94,7 +94,7 @@ Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `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
 
@@ -108,7 +108,7 @@ ID used for the Anki note ID
 
 > `optional` **jlpt**: `` `N${number}` ``
 
-Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L761)
+Defined in: [types.ts:829](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L829)
 
 #### See
 
@@ -120,7 +120,7 @@ Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `readonly` **kanji**: `string`
 
-Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L713)
+Defined in: [types.ts:781](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L781)
 
 #### See
 
@@ -132,7 +132,7 @@ Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **kokuji**: `true`
 
-Defined in: [types.ts:765](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L765)
+Defined in: [types.ts:833](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L833)
 
 Whether or not the kanji is a kokuji
 
@@ -142,7 +142,7 @@ Whether or not the kanji is a kokuji
 
 > `optional` **kunyomi**: `string`[]
 
-Defined in: [types.ts:729](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L729)
+Defined in: [types.ts:797](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L797)
 
 The kanji kunyomi readings
 
@@ -152,7 +152,7 @@ The kanji kunyomi readings
 
 > `optional` **meanings**: `string`[]
 
-Defined in: [types.ts:721](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L721)
+Defined in: [types.ts:789](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L789)
 
 #### See
 
@@ -164,7 +164,7 @@ Defined in: [types.ts:721](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **mnemonic**: `string`
 
-Defined in: [types.ts:745](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L745)
+Defined in: [types.ts:813](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L813)
 
 The kanji mnemonic
 
@@ -174,7 +174,7 @@ The kanji mnemonic
 
 > `optional` **nanori**: `string`[]
 
-Defined in: [types.ts:733](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L733)
+Defined in: [types.ts:801](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L801)
 
 #### See
 
@@ -186,7 +186,7 @@ Defined in: [types.ts:733](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `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
 
@@ -200,7 +200,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
 
@@ -214,7 +214,7 @@ Anki note type name
 
 > `optional` **onyomi**: `string`[]
 
-Defined in: [types.ts:725](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L725)
+Defined in: [types.ts:793](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L793)
 
 The kanji onyomi readings
 
@@ -224,7 +224,7 @@ The kanji onyomi readings
 
 > `optional` **source**: `string`
 
-Defined in: [types.ts:769](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L769)
+Defined in: [types.ts:837](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L837)
 
 The source (besides KANJIDIC) from which data for this kanji has been extracted
 
@@ -234,7 +234,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
 
 > `optional` **strokes**: `string`
 
-Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L717)
+Defined in: [types.ts:785](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L785)
 
 #### See
 
@@ -246,7 +246,7 @@ Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `optional` **svg**: `string`
 
-Defined in: [types.ts:737](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L737)
+Defined in: [types.ts:805](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L805)
 
 The kanji SVG filename
 
@@ -256,7 +256,7 @@ The kanji 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
 
@@ -270,6 +270,6 @@ Tags generated based on the entry's information
 
 > `optional` **words**: [`Word`](Word.md)[]
 
-Defined in: [types.ts:749](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L749)
+Defined in: [types.ts:817](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L817)
 
 Words that use the kanji

package/docs/api/interfaces/KanjiComponent.md

@@ -6,7 +6,7 @@
 
 # Interface: KanjiComponent
 
-Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L693)
+Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L761)
 
 Kanji component information
 
@@ -16,7 +16,7 @@ Kanji component information
 
 > `readonly` **component**: `string`
 
-Defined in: [types.ts:697](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L697)
+Defined in: [types.ts:765](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L765)
 
 The component character
 
@@ -26,6 +26,6 @@ The component character
 
 > `optional` **meaning**: `string`
 
-Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L701)
+Defined in: [types.ts:769](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L769)
 
 The meaning of the component

package/docs/api/interfaces/KanjiForm.md

@@ -6,9 +6,9 @@
 
 # Interface: KanjiForm
 
-Defined in: [types.ts:635](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L635)
+Defined in: [types.ts:703](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L703)
 
-A kanji form of the word
+A kanji form of the word/name
 
 Converted from a [DictKanjiForm](DictKanjiForm.md)
 
@@ -18,7 +18,7 @@ Converted from a [DictKanjiForm](DictKanjiForm.md)
 
 > `optional` **common**: `true`
 
-Defined in: [types.ts:647](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L647)
+Defined in: [types.ts:715](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L715)
 
 Whether or not the kanji form is common
 
@@ -28,7 +28,7 @@ Whether or not the kanji form is common
 
 > `readonly` **kanjiForm**: `string`
 
-Defined in: [types.ts:639](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L639)
+Defined in: [types.ts:707](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L707)
 
 The kanji form
 
@@ -38,6 +38,6 @@ The kanji form
 
 > `optional` **notes**: `string`[]
 
-Defined in: [types.ts:643](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L643)
+Defined in: [types.ts:711](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L711)
 
 Optional notes for the kanji form

package/docs/api/interfaces/Name.md

@@ -0,0 +1,163 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / Name
+
+# Interface: Name
+
+Defined in: [types.ts:955](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L955)
+
+Name information
+
+Converted from [DictName](DictName.md)
+
+## Extends
+
+- [`ResultEntry`](ResultEntry.md)\<`"name"`\>
+
+## Properties
+
+### common?
+
+> `optional` **common**: `true`
+
+Defined in: [types.ts:979](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L979)
+
+#### See
+
+[DictName.isCommon](DictName.md#iscommon)
+
+***
+
+### deckPath?
+
+> `optional` **deckPath**: `string`
+
+Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L673)
+
+The full path of the Anki deck
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`deckPath`](ResultEntry.md#deckpath)
+
+***
+
+### doNotCreateNote?
+
+> `optional` **doNotCreateNote**: `true`
+
+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
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
+
+***
+
+### id?
+
+> `optional` **id**: `` `${number}` ``
+
+Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L665)
+
+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:971](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L971)
+
+A list of kanji used in the kanji forms
+
+***
+
+### kanjiForms?
+
+> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
+
+Defined in: [types.ts:967](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L967)
+
+The name kanji forms
+
+***
+
+### nameReadings
+
+> **nameReadings**: [`Reading`](Reading.md)[]
+
+Defined in: [types.ts:959](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L959)
+
+The name readings (in kana)
+
+***
+
+### noteID?
+
+> `optional` **noteID**: `string`
+
+Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L661)
+
+ID used for the resulting Anki note
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteID`](ResultEntry.md#noteid)
+
+***
+
+### noteTypeName?
+
+> `optional` **noteTypeName**: `string`
+
+Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L669)
+
+Anki note type name
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`noteTypeName`](ResultEntry.md#notetypename)
+
+***
+
+### phrases?
+
+> `optional` **phrases**: [`Phrase`](Phrase.md)[]
+
+Defined in: [types.ts:975](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L975)
+
+Phrases associated to the name
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L677)
+
+Tags generated based on the entry's information
+
+#### Inherited from
+
+[`ResultEntry`](ResultEntry.md).[`tags`](ResultEntry.md#tags)
+
+***
+
+### translations
+
+> **translations**: [`Translation`](Translation.md)[]
+
+Defined in: [types.ts:963](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L963)
+
+The name translations

package/docs/api/interfaces/NeDictMeaning.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / NeDictMeaning
+
+# Interface: NeDictMeaning
+
+Defined in: [types.ts:229](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L229)
+
+Name translation information
+
+Equivalent to the `trans` JMnedict element
+
+## Properties
+
+### nameTypes?
+
+> `optional` **nameTypes**: `string`[]
+
+Defined in: [types.ts:237](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L237)
+
+Types of the name
+
+***
+
+### translations
+
+> **translations**: `string`[]
+
+Defined in: [types.ts:233](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L233)
+
+Name translations

package/docs/api/interfaces/NoteAndTag.md

@@ -6,7 +6,7 @@
 
 # Interface: NoteAndTag
 
-Defined in: [types.ts:619](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L619)
+Defined in: [types.ts:687](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L687)
 
 A pair of a "kanji form"/"reading"/"sense" note and its associated tag
 
@@ -16,7 +16,7 @@ A pair of a "kanji form"/"reading"/"sense" note and its associated tag
 
 > `readonly` **note**: `string`
 
-Defined in: [types.ts:623](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L623)
+Defined in: [types.ts:691](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L691)
 
 The note
 
@@ -26,6 +26,6 @@ The note
 
 > `readonly` `optional` **tag**: `string`
 
-Defined in: [types.ts:627](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L627)
+Defined in: [types.ts:695](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L695)
 
 The tag

package/docs/api/interfaces/NoteHeaderKeys.md

@@ -6,7 +6,7 @@
 
 # Interface: NoteHeaderKeys
 
-Defined in: [types.ts:995](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L995)
+Defined in: [types.ts:1095](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1095)
 
 Anki note file headers keys
 
@@ -20,7 +20,7 @@ Anki note file headers keys
 
 > `readonly` **deck**: `` `${string}:` ``
 
-Defined in: [types.ts:1015](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1015)
+Defined in: [types.ts:1115](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1115)
 
 Deck name column header
 
@@ -30,7 +30,7 @@ Deck name column header
 
 > `readonly` **guid**: `` `${string}:` ``
 
-Defined in: [types.ts:1007](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1007)
+Defined in: [types.ts:1107](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1107)
 
 GUID column header
 
@@ -40,7 +40,7 @@ GUID column header
 
 > `readonly` **html**: `` `${string}:false` `` \| `` `${string}:true` ``
 
-Defined in: [types.ts:1003](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1003)
+Defined in: [types.ts:1103](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1103)
 
 HTML treatment
 
@@ -50,7 +50,7 @@ HTML treatment
 
 > `readonly` **notetype**: `` `${string}:` ``
 
-Defined in: [types.ts:1011](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1011)
+Defined in: [types.ts:1111](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1111)
 
 Note type column header
 
@@ -60,7 +60,7 @@ Note type column header
 
 > `readonly` **separator**: `` `${string}:${string}` ``
 
-Defined in: [types.ts:999](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L999)
+Defined in: [types.ts:1099](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1099)
 
 Field separator
 
@@ -70,6 +70,6 @@ Field separator
 
 > `readonly` **tags**: `` `${string}:` ``
 
-Defined in: [types.ts:1019](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1019)
+Defined in: [types.ts:1119](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1119)
 
 Tags column header (*must be completed with a number after `:`*)

package/docs/api/interfaces/Phrase.md

@@ -6,7 +6,7 @@
 
 # Interface: Phrase
 
-Defined in: [types.ts:823](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L823)
+Defined in: [types.ts:891](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L891)
 
 Phrase information
 
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
 
 > `readonly` `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
 
-Defined in: [types.ts:839](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L839)
+Defined in: [types.ts:907](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L907)
 
 #### See
 
@@ -30,7 +30,7 @@ Defined in: [types.ts:839](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `readonly` **originalPhrase**: `string`
 
-Defined in: [types.ts:835](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L835)
+Defined in: [types.ts:903](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L903)
 
 #### See
 
@@ -42,7 +42,7 @@ Defined in: [types.ts:835](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 > `readonly` **phrase**: `string`
 
-Defined in: [types.ts:827](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L827)
+Defined in: [types.ts:895](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L895)
 
 The Japanese phrase, either with furigana attached or not
 
@@ -52,7 +52,7 @@ The Japanese phrase, either with furigana attached or not
 
 > `readonly` **translation**: `string`
 
-Defined in: [types.ts:831](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L831)
+Defined in: [types.ts:899](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L899)
 
 #### See