henkan 2.0.4 → 2.2.0

package/docs/api/functions/generateAnkiNotesFile.md

@@ -8,7 +8,7 @@
 
 > **generateAnkiNotesFile**(`list`, `defaultNoteInfo?`): `string`
 
-Defined in: [utils.ts:2688](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2688)
+Defined in: [utils.ts:2751](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2751)
 
 Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
 

package/docs/api/functions/getKanji.md

@@ -8,35 +8,35 @@
 
 > **getKanji**(`kanji`, `dict?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-Defined in: [utils.ts:2019](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2019)
+Defined in: [utils.ts:2096](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2096)
 
-Transforms a converted `KANJIDIC` entry into a more readable format
+Transforms a converted `KANJIDIC` entry into a more readable format, by providing either the kanji or the [DictKanji](../interfaces/DictKanji.md) object directly.
 
 ## Parameters
 
 ### kanji
 
-The kanji character or a [DictKanji](../interfaces/DictKanji.md) object
+The kanji character (requires [dict](#getkanji)) or a [DictKanji](../interfaces/DictKanji.md) object
 
 `string` | [`DictKanji`](../interfaces/DictKanji.md)
 
 ### dict?
 
-readonly [`DictKanji`](../interfaces/DictKanji.md)[]
+An array of converted `KANJIDIC` entries or a [KanjiEntryMap](../type-aliases/KanjiEntryMap.md) (not needed if [kanji](#getkanji) is a [DictKanji](../interfaces/DictKanji.md) object)
 
-An array of converted `KANJIDIC` entries (not needed if [kanji](#getkanji) is a [DictKanji](../interfaces/DictKanji.md) object)
+[`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md) | readonly [`DictKanji`](../interfaces/DictKanji.md)[]
 
 ### jmDict?
 
-An array or a kanji-words map of converted `JMdict` entries
+An array of converted `JMdict` entries or a [KanjiWordsMap](../type-aliases/KanjiWordsMap.md)
 
-readonly [`DictWord`](../interfaces/DictWord.md)[] | `Map`\<`string`, readonly [`DictWord`](../interfaces/DictWord.md)[]\>
+[`KanjiWordsMap`](../type-aliases/KanjiWordsMap.md) | readonly [`DictWord`](../interfaces/DictWord.md)[]
 
 ### svgList?
 
-readonly `string`[]
+An array of SVG file names or a [KanjiSVGMap](../type-aliases/KanjiSVGMap.md)
 
-An array of SVG file names
+[`KanjiSVGMap`](../type-aliases/KanjiSVGMap.md) | readonly `string`[]
 
 ### noteTypeName?
 
@@ -54,4 +54,4 @@ The full Anki deck path
 
 [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-The transformed [Kanji](../interfaces/Kanji.md) object or `undefined` if entry is not found
+The transformed [DictKanji](../interfaces/DictKanji.md) object or `undefined` if entry is not found

package/docs/api/functions/getKanjiExtended.md

@@ -8,7 +8,7 @@
 
 > **getKanjiExtended**(`info`, `kanji`, `dict?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`, `sourceURL?`): [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-Defined in: [utils.ts:2221](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2221)
+Defined in: [utils.ts:2290](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2290)
 
 Same as [getKanji](getKanji.md), but with possible extra info.
 
@@ -28,9 +28,9 @@ The kanji character or a [DictKanji](../interfaces/DictKanji.md) object
 
 ### dict?
 
-readonly [`DictKanji`](../interfaces/DictKanji.md)[]
+An array of converted KANJIDIC entries or a [KanjiEntryMap](../type-aliases/KanjiEntryMap.md) *(not needed if [kanji](#getkanjiextended) is a [DictKanji](../interfaces/DictKanji.md) object)*
 
-An array of converted `KANJIDIC` entries
+[`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md) | readonly [`DictKanji`](../interfaces/DictKanji.md)[]
 
 ### useWords?
 
@@ -40,15 +40,15 @@ Whether or not to use the words provided in the `info` object (if present) inste
 
 ### jmDict?
 
-An array or a kanji-words map of converted `JMdict` entries
+An array of converted `JMdict` entries or a [KanjiWordsMap](../type-aliases/KanjiWordsMap.md)
 
-readonly [`DictWord`](../interfaces/DictWord.md)[] | `Map`\<`string`, readonly [`DictWord`](../interfaces/DictWord.md)[]\>
+[`KanjiWordsMap`](../type-aliases/KanjiWordsMap.md) | readonly [`DictWord`](../interfaces/DictWord.md)[]
 
 ### svgList?
 
-readonly `string`[]
+An array of SVG file names or a [KanjiSVGMap](../type-aliases/KanjiSVGMap.md)
 
-An array of SVG file names
+[`KanjiSVGMap`](../type-aliases/KanjiSVGMap.md) | readonly `string`[]
 
 ### noteTypeName?
 
@@ -72,4 +72,4 @@ A link leading to the source of [info](#getkanjiextended)
 
 [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-The transformed [Kanji](../interfaces/Kanji.md) object
+The transformed [DictKanji](../interfaces/DictKanji.md) object

package/docs/api/functions/getValidForms.md

@@ -0,0 +1,39 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / getValidForms
+
+# Function: getValidForms()
+
+> **getValidForms**(`readings`, `kanjiForms?`, `wordIsCommon?`): [`ReadingsKanjiFormsPair`](../interfaces/ReadingsKanjiFormsPair.md)
+
+Defined in: [utils.ts:126](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L126)
+
+Filters out all the old/rare or (if [wordIsCommon](#getvalidforms) is `true`) uncommon readings and kanji forms of a JMdict entry.
+
+## Parameters
+
+### readings
+
+readonly [`DictReading`](../interfaces/DictReading.md)[]
+
+The word's readings
+
+### kanjiForms?
+
+readonly [`DictKanjiForm`](../interfaces/DictKanjiForm.md)[]
+
+The word's kanji forms
+
+### wordIsCommon?
+
+`true`
+
+Whether or not the word is common
+
+## Returns
+
+[`ReadingsKanjiFormsPair`](../interfaces/ReadingsKanjiFormsPair.md)
+
+An object containing the valid readings and kanji forms of the word

package/docs/api/functions/getWord.md

@@ -8,7 +8,7 @@
 
 > **getWord**(`word`, `dict?`, `kanjiDic?`, `examples?`, `definitions?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md) \| `undefined`
 
-Defined in: [utils.ts:1611](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1611)
+Defined in: [utils.ts:1716](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1716)
 
 Transforms a converted `JMdict` entry into a more readable format, by providing either its JMdict entry ID or the [DictWord](../interfaces/DictWord.md) object directly.
 
@@ -16,33 +16,33 @@ Transforms a converted `JMdict` entry into a more readable format, by providing
 
 ### word
 
-The ID of the `JMdict` entry or a [DictWord](../interfaces/DictWord.md) object
+The ID of the `JMdict` entry (requires [dict](#getword)) or a [DictWord](../interfaces/DictWord.md) object
 
 `` `${number}` `` | [`DictWord`](../interfaces/DictWord.md)
 
 ### dict?
 
-readonly [`DictWord`](../interfaces/DictWord.md)[]
+An array converted `JMdict` entries or a [WordIDEntryMap](../type-aliases/WordIDEntryMap.md) *(not needed if [word](#getword) is a [DictWord](../interfaces/DictWord.md) object)*
 
-An array of converted `JMdict` entries (not needed if [word](#getword) is a [DictWord](../interfaces/DictWord.md) object)
+[`WordIDEntryMap`](../type-aliases/WordIDEntryMap.md) | readonly [`DictWord`](../interfaces/DictWord.md)[]
 
 ### kanjiDic?
 
-An array or an ID-kanji map of converted `KANJIDIC` entries
+An array of converted `KANJIDIC` entries or a [KanjiEntryMap](../type-aliases/KanjiEntryMap.md)
 
-readonly [`DictKanji`](../interfaces/DictKanji.md)[] | `Map`\<`string`, readonly [`DictKanji`](../interfaces/DictKanji.md)[]\>
+[`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md) | readonly [`DictKanji`](../interfaces/DictKanji.md)[]
 
 ### examples?
 
-An array of converted `Tanaka Corpus` examples
+An array of converted `Tanaka Corpus` examples or a [WordExamplesMap](../type-aliases/WordExamplesMap.md)
 
-readonly [`TanakaExample`](../interfaces/TanakaExample.md)[] | `Map`\<`string`, readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]\>
+[`WordExamplesMap`](../type-aliases/WordExamplesMap.md) | readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]
 
 ### definitions?
 
-An array or ID-definitions map of `ja.wiktionary.org` word definitions
+An array of `ja.wiktionary.org` word-definitions pairs or a [WordDefinitionsMap](../type-aliases/WordDefinitionsMap.md)
 
-`Map`\<`string`, readonly [`Definition`](../interfaces/Definition.md)[]\> | readonly [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
+[`WordDefinitionsMap`](../type-aliases/WordDefinitionsMap.md) | readonly [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
 
 ### noteTypeName?
 
@@ -60,4 +60,4 @@ The full Anki deck path
 
 [`Word`](../interfaces/Word.md) \| `undefined`
 
-The transformed [Word](../interfaces/Word.md) object or `undefined` if entry is not found
+The transformed [DictWord](../interfaces/DictWord.md) object or `undefined` if entry is not found

package/docs/api/functions/getWordDefinitions.md

@@ -8,7 +8,7 @@
 
 > **getWordDefinitions**(`entryList`, `jmDict`): [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
 
-Defined in: [utils.ts:869](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L869)
+Defined in: [utils.ts:1040](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1040)
 
 Pairs Japanese definitions with JMdict word entries
 

package/docs/api/functions/getWordDefinitionsWithFurigana.md

@@ -8,7 +8,7 @@
 
 > **getWordDefinitionsWithFurigana**(`entryList`, `jmDict`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
 
-Defined in: [utils.ts:1533](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1533)
+Defined in: [utils.ts:1638](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1638)
 
 Pairs Japanese definitions with JMdict word entries (with furigana)
 

package/docs/api/functions/isObjectArray.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / isObjectArray
+
+# Function: isObjectArray()
+
+> **isObjectArray**(`arg`): `arg is any[]`
+
+Defined in: [utils.ts:94](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L94)
+
+Checks if the argument is an array of object.
+
+## Parameters
+
+### arg
+
+`unknown`
+
+The argument
+
+## Returns
+
+`arg is any[]`
+
+Whether or not [arg](#isobjectarray) is an array of objects

package/docs/api/functions/isStringArray.md

@@ -8,7 +8,7 @@
 
 > **isStringArray**(`arg`): `arg is string[]`
 
-Defined in: [utils.ts:87](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L87)
+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.
 
@@ -16,7 +16,7 @@ Checks if the argument is an array of strings.
 
 ### arg
 
-`any`
+`unknown`
 
 The argument
 

package/docs/api/functions/isValidArrayWithFirstElement.md

@@ -8,7 +8,7 @@
 
 > **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
 
-Defined in: [utils.ts:72](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L72)
+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.
 
@@ -16,7 +16,7 @@ Checks if the argument is an array and has at least one element.
 
 ### arg
 
-`any`
+`unknown`
 
 The argument
 

package/docs/api/functions/shuffleArray.md

@@ -8,7 +8,7 @@
 
 > **shuffleArray**\<`T`\>(`arr`): `T`[]
 
-Defined in: [utils.ts:101](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L101)
+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:883](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L883)
+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:897](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L897)
+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:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
+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:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
+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:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
+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:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
+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:459](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L459)
+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:463](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L463)
+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/DictKanji.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanji
 
-Defined in: [types.ts:290](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L290)
+Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L309)
 
 KANJIDIC2 entry (kanji)
 
@@ -18,7 +18,7 @@ Equivalent to the `character` KANJIDIC2 element *(excluding some subelements)*
 
 > `optional` **isKokuji**: `true`
 
-Defined in: [types.ts:306](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L306)
+Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L325)
 
 Whether or not the kanji is kokuji
 
@@ -28,7 +28,7 @@ Whether or not the kanji is kokuji
 
 > `readonly` **kanji**: `string`
 
-Defined in: [types.ts:294](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L294)
+Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L313)
 
 The kanji character
 
@@ -38,7 +38,7 @@ The kanji character
 
 > `optional` **misc**: [`DictKanjiMisc`](DictKanjiMisc.md)
 
-Defined in: [types.ts:298](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L298)
+Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L317)
 
 The miscellaneous information about the kanji
 
@@ -48,6 +48,6 @@ The miscellaneous information about the kanji
 
 > `optional` **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
 
-Defined in: [types.ts:302](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L302)
+Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L321)
 
 The "readings-meanings" groups and nanori readings of the kanji

package/docs/api/interfaces/DictKanjiForm.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiForm
 
-Defined in: [types.ts:57](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L57)
+Defined in: [types.ts:62](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L62)
 
 Word kanji form information
 
@@ -18,7 +18,7 @@ Equivalent to the `k_ele` JMdict element
 
 > `optional` **commonness**: `string`[]
 
-Defined in: [types.ts:73](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L73)
+Defined in: [types.ts:78](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L78)
 
 Priority codes
 
@@ -32,7 +32,7 @@ Priority codes
 
 > `readonly` **form**: `string`
 
-Defined in: [types.ts:61](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L61)
+Defined in: [types.ts:66](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L66)
 
 The kanji form of the word
 
@@ -42,7 +42,7 @@ The kanji form of the word
 
 > `optional` **notes**: `string`[]
 
-Defined in: [types.ts:67](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L67)
+Defined in: [types.ts:72](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L72)
 
 Other information about the kanji form
 

package/docs/api/interfaces/DictKanjiMisc.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiMisc
 
-Defined in: [types.ts:212](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L212)
+Defined in: [types.ts:231](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L231)
 
 Miscellaneous information about the kanji
 
@@ -18,7 +18,7 @@ Equivalent to the `misc` KANJIDIC2 element *(excluding some subelements)*
 
 > `optional` **frequency**: `string`
 
-Defined in: [types.ts:232](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L232)
+Defined in: [types.ts:251](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L251)
 
 The frequency-of-use ranking
 
@@ -30,7 +30,7 @@ A number from `1` to `2500`
 
 > `optional` **grade**: `string`
 
-Defined in: [types.ts:226](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L226)
+Defined in: [types.ts:245](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L245)
 
 The kanji grade level
 
@@ -46,7 +46,7 @@ The kanji grade level
 
 > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
 
-Defined in: [types.ts:236](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L236)
+Defined in: [types.ts:255](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L255)
 
 The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Previous_format_(1984%E2%80%932009)) level
 
@@ -56,6 +56,6 @@ The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_
 
 > `optional` **strokeNumber**: `string`
 
-Defined in: [types.ts:216](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L216)
+Defined in: [types.ts:235](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L235)
 
 The stroke count of the kanji, including the radical

package/docs/api/interfaces/DictKanjiReading.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiReading
 
-Defined in: [types.ts:242](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L242)
+Defined in: [types.ts:261](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L261)
 
 Kanji reading information
 
@@ -16,7 +16,7 @@ Kanji reading information
 
 > `readonly` **reading**: `string`
 
-Defined in: [types.ts:246](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L246)
+Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L265)
 
 The kanji reading (hiragana or katakana)
 
@@ -26,6 +26,6 @@ The kanji reading (hiragana or katakana)
 
 > **type**: `"ja_on"` \| `"ja_kun"`
 
-Defined in: [types.ts:250](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L250)
+Defined in: [types.ts:269](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L269)
 
 The type of reading (onyomi or kunyomi)

package/docs/api/interfaces/DictKanjiReadingMeaning.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiReadingMeaning
 
-Defined in: [types.ts:274](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L274)
+Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L293)
 
 Kanji "readings-meanings" groups and nanori readings
 
@@ -18,7 +18,7 @@ Equivalent to the `reading_meaning` KANJIDIC2 element
 
 > `optional` **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
 
-Defined in: [types.ts:278](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L278)
+Defined in: [types.ts:297](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L297)
 
 The Kanji "readings-meanings" pairs
 
@@ -28,6 +28,6 @@ The Kanji "readings-meanings" pairs
 
 > `optional` **nanori**: `string`[]
 
-Defined in: [types.ts:282](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L282)
+Defined in: [types.ts:301](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L301)
 
 The kanji nanori readings

package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiReadingMeaningGroup
 
-Defined in: [types.ts:258](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L258)
+Defined in: [types.ts:277](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L277)
 
 Kanji "readings-meanings" pair
 
@@ -18,7 +18,7 @@ Equivalent to the `rmgroup` KANJIDIC2 element
 
 > `optional` **meanings**: `string`[]
 
-Defined in: [types.ts:266](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L266)
+Defined in: [types.ts:285](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L285)
 
 The kanji meanings
 
@@ -28,6 +28,6 @@ The kanji meanings
 
 > `optional` **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
 
-Defined in: [types.ts:262](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L262)
+Defined in: [types.ts:281](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L281)
 
 The kanji readings

package/docs/api/interfaces/DictKanjiWithRadicals.md

@@ -6,7 +6,7 @@
 
 # Interface: DictKanjiWithRadicals
 
-Defined in: [types.ts:330](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L330)
+Defined in: [types.ts:349](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L349)
 
 KRADFILE2 entry (kanji with its radicals/components)
 
@@ -16,7 +16,7 @@ KRADFILE2 entry (kanji with its radicals/components)
 
 > `readonly` **kanji**: `string`
 
-Defined in: [types.ts:334](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L334)
+Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L353)
 
 The kanji character
 
@@ -26,7 +26,7 @@ The kanji character
 
 > **radicals**: [`DictKanji`](DictKanji.md)[]
 
-Defined in: [types.ts:340](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L340)
+Defined in: [types.ts:359](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L359)
 
 The radicals/components that make up the kanji