henkan 1.1.2 → 2.0.0

package/docs/api/functions/convertTanakaCorpusWithFurigana.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertTanakaCorpusWithFurigana
+
+# Function: convertTanakaCorpusWithFurigana()
+
+> **convertTanakaCorpusWithFurigana**(`tanakaString`): `Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
+
+Defined in: [utils.ts:561](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L561)
+
+Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](../interfaces/TanakaExample.md) objects (with furigana).
+
+## Parameters
+
+### tanakaString
+
+`string`
+
+The raw contents of a `examples.utf` file
+
+## Returns
+
+`Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
+
+A promise resolving with an array of converted [TanakaExample](../interfaces/TanakaExample.md) objects (with furigana)

package/docs/api/functions/generateAnkiNote.md

@@ -8,7 +8,7 @@
 
 > **generateAnkiNote**(`entry`): `string`[]
 
-Defined in: [utils.ts:2494](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2494)
+Defined in: [utils.ts:2306](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2306)
 
 Generates an array where each field holds an entry’s info wrapped in HTML tags.
 

package/docs/api/functions/generateAnkiNotesFile.md

@@ -6,9 +6,9 @@
 
 # Function: generateAnkiNotesFile()
 
-> **generateAnkiNotesFile**(`list`): `string`
+> **generateAnkiNotesFile**(`list`, `defaultNoteInfo?`): `string`
 
-Defined in: [utils.ts:2851](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2851)
+Defined in: [utils.ts:2654](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2654)
 
 Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
 
@@ -16,10 +16,16 @@ Generates an Anki notes file with each entry’s info organized into fields, eit
 
 ### list
 
-[`Result`](../type-aliases/Result.md)[]
+readonly [`Result`](../type-aliases/Result.md)[]
 
 An array containing any type of transformed entries ([Word](../interfaces/Word.md), [Kanji](../interfaces/Kanji.md), [Radical](../interfaces/Radical.md), [Kana](../interfaces/Kana.md), [Grammar](../interfaces/Grammar.md))
 
+### defaultNoteInfo?
+
+[`DefaultNoteInfo`](../interfaces/DefaultNoteInfo.md)
+
+An object with options regarding default values of some note information
+
 ## Returns
 
 `string`

package/docs/api/functions/getKanji.md

@@ -6,41 +6,35 @@
 
 # Function: getKanji()
 
-> **getKanji**(`dict`, `kanjiChar?`, `dictKanji?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
+> **getKanji**(`kanji`, `dict?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-Defined in: [utils.ts:2065](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2065)
+Defined in: [utils.ts:2019](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2019)
 
 Transforms a converted `KANJIDIC` entry into a more readable format
 
 ## Parameters
 
-### dict
+### kanji
 
-[`DictKanji`](../interfaces/DictKanji.md)[]
+The kanji character or a [DictKanji](../interfaces/DictKanji.md) object
 
-An array of converted `KANJIDIC` entries
-
-### kanjiChar?
-
-`string`
-
-The kanji character
+`string` | [`DictKanji`](../interfaces/DictKanji.md)
 
-### dictKanji?
+### dict?
 
-[`DictKanji`](../interfaces/DictKanji.md)
+readonly [`DictKanji`](../interfaces/DictKanji.md)[]
 
-A [DictKanji](../interfaces/DictKanji.md) object
+An array of converted `KANJIDIC` entries
 
 ### jmDict?
 
-[`DictWord`](../interfaces/DictWord.md)[]
+An array or a kanji-words map of converted `JMdict` entries
 
-An array of converted `JMdict` entries
+readonly [`DictWord`](../interfaces/DictWord.md)[] | `Map`\<`string`, readonly [`DictWord`](../interfaces/DictWord.md)[]\>
 
 ### svgList?
 
-`string`[]
+readonly `string`[]
 
 An array of SVG file names
 
@@ -58,6 +52,6 @@ The full Anki deck path
 
 ## Returns
 
-[`Kanji`](../interfaces/Kanji.md)
+[`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-The transformed [Kanji](../interfaces/Kanji.md) object
+The transformed [Kanji](../interfaces/Kanji.md) object or `undefined` if entry is not found

package/docs/api/functions/getKanjiExtended.md

@@ -6,9 +6,9 @@
 
 # Function: getKanjiExtended()
 
-> **getKanjiExtended**(`info`, `dict`, `kanjiChar?`, `dictKanji?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
+> **getKanjiExtended**(`info`, `kanji`, `dict?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`, `sourceURL?`): [`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
-Defined in: [utils.ts:2328](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2328)
+Defined in: [utils.ts:2187](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2187)
 
 Same as [getKanji](getKanji.md), but with possible extra info.
 
@@ -20,23 +20,17 @@ Same as [getKanji](getKanji.md), but with possible extra info.
 
 Additional info for the kanji (mnemonic, components, words)
 
-### dict
+### kanji
 
-[`DictKanji`](../interfaces/DictKanji.md)[]
+The kanji character or a [DictKanji](../interfaces/DictKanji.md) object
 
-An array of converted `KANJIDIC` entries
-
-### kanjiChar?
-
-`string`
-
-The kanji character
+`string` | [`DictKanji`](../interfaces/DictKanji.md)
 
-### dictKanji?
+### dict?
 
-[`DictKanji`](../interfaces/DictKanji.md)
+readonly [`DictKanji`](../interfaces/DictKanji.md)[]
 
-A [DictKanji](../interfaces/DictKanji.md) object
+An array of converted `KANJIDIC` entries
 
 ### useWords?
 
@@ -46,13 +40,13 @@ Whether or not to use the words provided in the `info` object (if present) inste
 
 ### jmDict?
 
-[`DictWord`](../interfaces/DictWord.md)[]
+An array or a kanji-words map of converted `JMdict` entries
 
-An array of converted `JMdict` entries
+readonly [`DictWord`](../interfaces/DictWord.md)[] | `Map`\<`string`, readonly [`DictWord`](../interfaces/DictWord.md)[]\>
 
 ### svgList?
 
-`string`[]
+readonly `string`[]
 
 An array of SVG file names
 
@@ -68,8 +62,14 @@ The Anki note type name
 
 The full Anki deck path
 
+### sourceURL?
+
+`string`
+
+A link leading to the source of [info](#getkanjiextended)
+
 ## Returns
 
-[`Kanji`](../interfaces/Kanji.md)
+[`Kanji`](../interfaces/Kanji.md) \| `undefined`
 
 The transformed [Kanji](../interfaces/Kanji.md) object

package/docs/api/functions/getWord.md

@@ -6,49 +6,43 @@
 
 # Function: getWord()
 
-> **getWord**(`dict?`, `id?`, `kanjiDic?`, `examples?`, `definitions?`, `dictWord?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md)
+> **getWord**(`word`, `dict?`, `kanjiDic?`, `examples?`, `definitions?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md) \| `undefined`
 
-Defined in: [utils.ts:1659](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1659)
+Defined in: [utils.ts:1611](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1611)
 
-Transforms a converted `JMdict` entry into a more readable format, by providing either its [id](#getword) or the [dictWord](#getword) object directly.
+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.
 
 ## Parameters
 
-### dict?
+### word
 
-[`DictWord`](../interfaces/DictWord.md)[]
+The ID of the `JMdict` entry or a [DictWord](../interfaces/DictWord.md) object
 
-An array of converted `JMdict` entries
+`` `${number}` `` | [`DictWord`](../interfaces/DictWord.md)
 
-### id?
+### dict?
 
-`string`
+readonly [`DictWord`](../interfaces/DictWord.md)[]
 
-The ID of the `JMdict` entry
+An array of converted `JMdict` entries
 
 ### kanjiDic?
 
-[`DictKanji`](../interfaces/DictKanji.md)[]
+An array or an ID-kanji map of converted `KANJIDIC` entries
 
-An array of converted `KANJIDIC` entries
+readonly [`DictKanji`](../interfaces/DictKanji.md)[] | `Map`\<`string`, readonly [`DictKanji`](../interfaces/DictKanji.md)[]\>
 
 ### examples?
 
-[`TanakaExample`](../interfaces/TanakaExample.md)[]
-
 An array of converted `Tanaka Corpus` examples
 
-### definitions?
-
-An array of `ja.wiktionary.org` word definitions
+readonly [`TanakaExample`](../interfaces/TanakaExample.md)[] | `Map`\<`string`, readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]\>
 
-[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[] | `Map`\<`string`, [`Definition`](../interfaces/Definition.md)[]\>
-
-### dictWord?
+### definitions?
 
-[`DictWord`](../interfaces/DictWord.md)
+An array or ID-definitions map of `ja.wiktionary.org` word definitions
 
-The converted `JMdict` entry
+`Map`\<`string`, readonly [`Definition`](../interfaces/Definition.md)[]\> | readonly [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
 
 ### noteTypeName?
 
@@ -64,6 +58,6 @@ The full Anki deck path
 
 ## Returns
 
-[`Word`](../interfaces/Word.md)
+[`Word`](../interfaces/Word.md) \| `undefined`
 
-The transformed [Word](../interfaces/Word.md) object
+The transformed [Word](../interfaces/Word.md) object or `undefined` if entry is not found

package/docs/api/functions/getWordDefinitions.md

@@ -6,9 +6,9 @@
 
 # Function: getWordDefinitions()
 
-> **getWordDefinitions**(`entryList`, `jmDict`, `generateFurigana?`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
+> **getWordDefinitions**(`entryList`, `jmDict`): [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
 
-Defined in: [utils.ts:911](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L911)
+Defined in: [utils.ts:869](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L869)
 
 Pairs Japanese definitions with JMdict word entries
 
@@ -16,24 +16,18 @@ Pairs Japanese definitions with JMdict word entries
 
 ### entryList
 
-`any`[]
+readonly [`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]
 
-An array containing `ja.wiktionary.org` Japanese entries (converted using [convertJawiktionary](convertJawiktionary.md))
+An array containing `ja.wiktionary.org` Japanese entries (converted using [convertJawiktionarySync](convertJawiktionarySync.md) or [convertJawiktionaryAsync](convertJawiktionaryAsync.md))
 
 ### jmDict
 
-[`DictWord`](../interfaces/DictWord.md)[]
+readonly [`DictWord`](../interfaces/DictWord.md)[]
 
 An array of converted `JMdict` entries
 
-### generateFurigana?
-
-`true`
-
-Whether or not to generate furigana for the definitions
-
 ## Returns
 
-`Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
+[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
 
 A promise resolving with an array of [WordDefinitionPair](../interfaces/WordDefinitionPair.md) objects

package/docs/api/functions/getWordDefinitionsWithFurigana.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / getWordDefinitionsWithFurigana
+
+# Function: getWordDefinitionsWithFurigana()
+
+> **getWordDefinitionsWithFurigana**(`entryList`, `jmDict`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
+
+Defined in: [utils.ts:1533](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1533)
+
+Pairs Japanese definitions with JMdict word entries (with furigana)
+
+## Parameters
+
+### entryList
+
+readonly [`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]
+
+An array containing `ja.wiktionary.org` Japanese entries (converted using [convertJawiktionarySync](convertJawiktionarySync.md) or [convertJawiktionaryAsync](convertJawiktionaryAsync.md))
+
+### jmDict
+
+readonly [`DictWord`](../interfaces/DictWord.md)[]
+
+An array of converted `JMdict` entries
+
+## Returns
+
+`Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
+
+A promise resolving with an array of [WordDefinitionPair](../interfaces/WordDefinitionPair.md) objects (with furigana)

package/docs/api/functions/isStringArray.md

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

package/docs/api/functions/isValidArray.md

@@ -8,7 +8,7 @@
 
 > **isValidArray**(`arg`): `arg is any[]`
 
-Defined in: [utils.ts:62](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L62)
+Defined in: [utils.ts:63](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L63)
 
 Checks if the argument is an array.
 

package/docs/api/functions/isValidArrayWithFirstElement.md

@@ -8,7 +8,7 @@
 
 > **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
 
-Defined in: [utils.ts:71](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L71)
+Defined in: [utils.ts:72](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L72)
 
 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:100](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L100)
+Defined in: [utils.ts:101](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L101)
 
 Shuffles an array using the `Fisher–Yates shuffle` algorithm
 
@@ -22,7 +22,7 @@ Shuffles an array using the `Fisher–Yates shuffle` algorithm
 
 ### arr
 
-`T`[]
+readonly `T`[]
 
 The array to be shuffled
 

package/docs/api/interfaces/DefaultNoteInfo.md

@@ -0,0 +1,51 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / DefaultNoteInfo
+
+# Interface: DefaultNoteInfo
+
+Defined in: [types.ts:883](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L883)
+
+Default note ID, note type and deck name of a note
+
+Setting any of the properties to:
+
+- a `string` will make that string the default note ID/note type/deck name of the note in case [Result.noteID](Grammar.md#noteid)/[Result.noteTypeName](Grammar.md#notetypename)/[Result.deckPath](Grammar.md#deckpath) is `undefined`.
+
+- `true` will require all [Result](../type-aliases/Result.md) objects to have [Result.noteID](Grammar.md#noteid)/[Result.noteTypeName](Grammar.md#notetypename)/[Result.deckPath](Grammar.md#deckpath) set (*no default values*).
+
+- `undefined` (*or not set*) will require all [Result](../type-aliases/Result.md) objects to either have [Result.noteID](Grammar.md#noteid)/[Result.noteTypeName](Grammar.md#notetypename)/[Result.deckPath](Grammar.md#deckpath) set or not set (*no default values*).
+
+## Properties
+
+### deckPath?
+
+> `optional` **deckPath**: `string` \| `true`
+
+Defined in: [types.ts:897](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L897)
+
+A default for [Result.deckPath](Grammar.md#deckpath)
+
+***
+
+### guid?
+
+> `optional` **guid**: `true` \| `"main_information"`
+
+Defined in: [types.ts:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
+
+A default for [Result.noteID](Grammar.md#noteid)
+
+`main_information` will make either the ID or kana/kanji/radical character the default note ID of the note.
+
+***
+
+### noteType?
+
+> `optional` **noteType**: `string` \| `true`
+
+Defined in: [types.ts:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
+
+A default for [Result.noteTypeName](Grammar.md#notetypename)

package/docs/api/interfaces/DictKanjiMisc.md

@@ -52,9 +52,9 @@ The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_
 
 ***
 
-### strokeNumber
+### strokeNumber?
 
-> `readonly` **strokeNumber**: `string`
+> `optional` **strokeNumber**: `string`
 
 Defined in: [types.ts:216](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L216)
 

package/docs/api/interfaces/DictKanjiReadingMeaning.md

@@ -14,9 +14,9 @@ Equivalent to the `reading_meaning` KANJIDIC2 element
 
 ## Properties
 
-### groups
+### groups?
 
-> **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
+> `optional` **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
 
 Defined in: [types.ts:278](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L278)
 

package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md

@@ -14,9 +14,9 @@ Equivalent to the `rmgroup` KANJIDIC2 element
 
 ## Properties
 
-### meanings
+### meanings?
 
-> **meanings**: `string`[]
+> `optional` **meanings**: `string`[]
 
 Defined in: [types.ts:266](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L266)
 
@@ -24,9 +24,9 @@ The kanji meanings
 
 ***
 
-### readings
+### readings?
 
-> **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
+> `optional` **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
 
 Defined in: [types.ts:262](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L262)
 

package/docs/api/interfaces/DictKanjiWithRadicals.md

@@ -24,10 +24,10 @@ The kanji character
 
 ### radicals
 
-> **radicals**: (`string` \| [`DictKanji`](DictKanji.md))[]
+> **radicals**: [`DictKanji`](DictKanji.md)[]
 
 Defined in: [types.ts:340](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L340)
 
 The radicals/components that make up the kanji
 
-Can be [DictKanji](DictKanji.md) objects if the component is a kanji found in KANJIDIC and/or [Kana.kana](Kana.md#kana) if the component is a katakana character that does not use (or have) its (or a) kanji variant.
+Can be [DictKanji](DictKanji.md) objects with either an actual kanji or a katakana character (which takes the place of the missing kanji)

package/docs/api/interfaces/DictWord.md

@@ -28,7 +28,7 @@ Whether or not the entry has at least one Tanaka Corpus phrase associated with i
 
 ### id
 
-> `readonly` **id**: `string`
+> `readonly` **id**: `` `${number}` ``
 
 Defined in: [types.ts:176](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L176)
 

package/docs/api/interfaces/Grammar.md

@@ -56,7 +56,7 @@ Whether or not this entry should be converted into an Anki note
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -90,7 +90,7 @@ The English meaning/translation of the grammar point
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `grammar_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/docs/api/interfaces/Kana.md

@@ -56,7 +56,7 @@ Whether or not this entry should be converted into an Anki note
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -80,7 +80,7 @@ The kana character
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `kana_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/docs/api/interfaces/Kanji.md

@@ -56,25 +56,25 @@ Whether or not this entry should be converted into an Anki note
 
 ***
 
-### frequency?
-
-> `optional` **frequency**: `string`
+### externalInfo?
 
-Defined in: [types.ts:667](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L667)
+> `optional` **externalInfo**: `true`
 
-#### See
+Defined in: [types.ts:683](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L683)
 
-[DictKanjiMisc.frequency](DictKanjiMisc.md#frequency)
+Whether or not this kanji object contains information extracted from [source](#source)
 
 ***
 
-### fromJpdb?
+### frequency?
 
-> `optional` **fromJpdb**: `true`
+> `optional` **frequency**: `string`
 
-Defined in: [types.ts:683](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L683)
+Defined in: [types.ts:667](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L667)
 
-Whether or not this kanji object contains information **only** from `jpdb.io`
+#### See
+
+[DictKanjiMisc.frequency](DictKanjiMisc.md#frequency)
 
 ***
 
@@ -92,7 +92,7 @@ Defined in: [types.ts:663](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 ### id?
 
-> `readonly` `optional` **id**: `string`
+> `optional` **id**: `` `${number}` ``
 
 Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
 
@@ -184,7 +184,7 @@ Defined in: [types.ts:643](https://github.com/Ronokof/Henkan/blob/main/src/types
 
 ### noteID?
 
-> `readonly` `optional` **noteID**: `` `kanji_${string}` ``
+> `optional` **noteID**: `string`
 
 Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
 

package/docs/api/interfaces/NoteAndTag.md

@@ -12,9 +12,9 @@ A pair of a "kanji form"/"reading"/"sense" note and its associated tag
 
 ## Properties
 
-### note?
+### note
 
-> `readonly` `optional` **note**: `string`
+> `readonly` **note**: `string`
 
 Defined in: [types.ts:533](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L533)