henkan 2.0.4 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist/index.cjs.js +789 -736
  2. package/dist/index.cjs.js.map +3 -3
  3. package/dist/index.mjs +781 -730
  4. package/dist/index.mjs.map +3 -3
  5. package/dist/types/constants.d.ts.map +1 -1
  6. package/dist/types/types.d.ts +93 -19
  7. package/dist/types/types.d.ts.map +1 -1
  8. package/dist/types/utils.d.ts +55 -28
  9. package/dist/types/utils.d.ts.map +1 -1
  10. package/docs/api/README.md +12 -1
  11. package/docs/api/functions/capitalizeString.md +1 -1
  12. package/docs/api/functions/convertJMdict.md +1 -1
  13. package/docs/api/functions/convertJawiktionaryAsync.md +1 -1
  14. package/docs/api/functions/convertJawiktionarySync.md +1 -1
  15. package/docs/api/functions/convertKanjiDic.md +1 -1
  16. package/docs/api/functions/convertKradFile.md +1 -1
  17. package/docs/api/functions/convertRadkFile.md +1 -1
  18. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  19. package/docs/api/functions/convertTanakaCorpusWithFurigana.md +1 -1
  20. package/docs/api/functions/createEntryMaps.md +59 -0
  21. package/docs/api/functions/generateAnkiNote.md +1 -1
  22. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  23. package/docs/api/functions/getKanji.md +10 -10
  24. package/docs/api/functions/getKanjiExtended.md +8 -8
  25. package/docs/api/functions/getValidForms.md +39 -0
  26. package/docs/api/functions/getWord.md +11 -11
  27. package/docs/api/functions/getWordDefinitions.md +1 -1
  28. package/docs/api/functions/getWordDefinitionsWithFurigana.md +1 -1
  29. package/docs/api/functions/isObjectArray.md +27 -0
  30. package/docs/api/functions/isStringArray.md +2 -2
  31. package/docs/api/functions/isValidArrayWithFirstElement.md +2 -2
  32. package/docs/api/functions/shuffleArray.md +1 -1
  33. package/docs/api/interfaces/DefaultNoteInfo.md +4 -4
  34. package/docs/api/interfaces/Definition.md +4 -4
  35. package/docs/api/interfaces/DictKanji.md +5 -5
  36. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  37. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  38. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  39. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  40. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  41. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  42. package/docs/api/interfaces/DictMeaning.md +15 -15
  43. package/docs/api/interfaces/DictRadical.md +4 -4
  44. package/docs/api/interfaces/DictReading.md +5 -5
  45. package/docs/api/interfaces/DictWord.md +9 -9
  46. package/docs/api/interfaces/EntryMaps.md +83 -0
  47. package/docs/api/interfaces/ExamplePart.md +8 -8
  48. package/docs/api/interfaces/GlossSpecificNumber.md +4 -4
  49. package/docs/api/interfaces/Grammar.md +15 -15
  50. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  51. package/docs/api/interfaces/JaWiktionaryEntry.md +8 -20
  52. package/docs/api/interfaces/Kana.md +11 -11
  53. package/docs/api/interfaces/Kanji.md +24 -24
  54. package/docs/api/interfaces/KanjiComponent.md +3 -3
  55. package/docs/api/interfaces/KanjiForm.md +4 -4
  56. package/docs/api/interfaces/NoteAndTag.md +3 -3
  57. package/docs/api/interfaces/NoteHeaderKeys.md +7 -7
  58. package/docs/api/interfaces/Phrase.md +5 -5
  59. package/docs/api/interfaces/Radical.md +16 -16
  60. package/docs/api/interfaces/Reading.md +5 -5
  61. package/docs/api/interfaces/ReadingsKanjiFormsPair.md +31 -0
  62. package/docs/api/interfaces/ResultEntry.md +7 -7
  63. package/docs/api/interfaces/TanakaExample.md +7 -7
  64. package/docs/api/interfaces/Translation.md +3 -3
  65. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  66. package/docs/api/interfaces/Word.md +15 -15
  67. package/docs/api/interfaces/WordDefinitionPair.md +4 -4
  68. package/docs/api/type-aliases/Dict.md +1 -1
  69. package/docs/api/type-aliases/DictTranslation.md +1 -1
  70. package/docs/api/type-aliases/EntryType.md +1 -1
  71. package/docs/api/type-aliases/KanjiEntryMap.md +13 -0
  72. package/docs/api/type-aliases/KanjiSVGMap.md +13 -0
  73. package/docs/api/type-aliases/KanjiWordsMap.md +13 -0
  74. package/docs/api/type-aliases/Result.md +1 -1
  75. package/docs/api/type-aliases/StringNumber.md +13 -0
  76. package/docs/api/type-aliases/WordDefinitionsMap.md +13 -0
  77. package/docs/api/type-aliases/WordExamplesMap.md +13 -0
  78. package/docs/api/type-aliases/WordIDEntryMap.md +13 -0
  79. package/package.json +4 -4
  80. package/docs/api/functions/isValidArray.md +0 -27
package/docs/api/interfaces/Kana.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kana
8
8
 
9
- Defined in: [types.ts:795](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L795)
9
+ Defined in: [types.ts:877](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L877)
10
10
 
11
11
  Kana information
12
12
 
@@ -20,7 +20,7 @@ Kana information
20
20
 
21
21
  > `optional` **audio**: `string`
22
22
 
23
- Defined in: [types.ts:807](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L807)
23
+ Defined in: [types.ts:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
24
24
 
25
25
  The filename of an audio file for the kana reading
26
26
 
@@ -30,7 +30,7 @@ The filename of an audio file for the kana reading
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: [types.ts:515](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L515)
33
+ Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
34
34
 
35
35
  The full path of the Anki deck
36
36
 
@@ -44,7 +44,7 @@ The full path of the Anki deck
44
44
 
45
45
  > `optional` **doNotCreateNote**: `true`
46
46
 
47
- Defined in: [types.ts:523](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L523)
47
+ Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
48
48
 
49
49
  Whether or not this entry should be converted into an Anki note
50
50
 
@@ -58,7 +58,7 @@ Whether or not this entry should be converted into an Anki note
58
58
 
59
59
  > `optional` **id**: `` `${number}` ``
60
60
 
61
- Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
61
+ Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
62
62
 
63
63
  ID used for the Anki note ID
64
64
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
72
72
 
73
73
  > `readonly` **kana**: `string`
74
74
 
75
- Defined in: [types.ts:799](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L799)
75
+ Defined in: [types.ts:881](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L881)
76
76
 
77
77
  The kana character
78
78
 
@@ -82,7 +82,7 @@ The kana character
82
82
 
83
83
  > `optional` **noteID**: `string`
84
84
 
85
- Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
85
+ Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
86
86
 
87
87
  ID used for the resulting Anki note
88
88
 
@@ -96,7 +96,7 @@ ID used for the resulting Anki note
96
96
 
97
97
  > `optional` **noteTypeName**: `string`
98
98
 
99
- Defined in: [types.ts:511](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L511)
99
+ Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
100
100
 
101
101
  Anki note type name
102
102
 
@@ -110,7 +110,7 @@ Anki note type name
110
110
 
111
111
  > **reading**: `string`
112
112
 
113
- Defined in: [types.ts:803](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L803)
113
+ Defined in: [types.ts:885](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L885)
114
114
 
115
115
  The romaji reading of the kana
116
116
 
@@ -120,7 +120,7 @@ The romaji reading of the kana
120
120
 
121
121
  > `optional` **svg**: `string`
122
122
 
123
- Defined in: [types.ts:811](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L811)
123
+ Defined in: [types.ts:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
124
124
 
125
125
  The kana SVG filename
126
126
 
@@ -130,7 +130,7 @@ The kana SVG filename
130
130
 
131
131
  > `optional` **tags**: `string`[]
132
132
 
133
- Defined in: [types.ts:519](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L519)
133
+ Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
134
134
 
135
135
  Tags generated based on the entry's information
136
136
 
package/docs/api/interfaces/Kanji.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kanji
8
8
 
9
- Defined in: [types.ts:619](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L619)
9
+ Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L701)
10
10
 
11
11
  Kanji information
12
12
 
@@ -22,7 +22,7 @@ Converted from [DictKanji](DictKanji.md) and extra info added
22
22
 
23
23
  > `optional` **components**: [`KanjiComponent`](KanjiComponent.md)[]
24
24
 
25
- Defined in: [types.ts:651](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L651)
25
+ Defined in: [types.ts:733](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L733)
26
26
 
27
27
  The kanji radicals/components
28
28
 
@@ -32,7 +32,7 @@ The kanji radicals/components
32
32
 
33
33
  > `optional` **deckPath**: `string`
34
34
 
35
- Defined in: [types.ts:515](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L515)
35
+ Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
36
36
 
37
37
  The full path of the Anki deck
38
38
 
@@ -46,7 +46,7 @@ The full path of the Anki deck
46
46
 
47
47
  > `optional` **doNotCreateNote**: `true`
48
48
 
49
- Defined in: [types.ts:523](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L523)
49
+ Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
50
50
 
51
51
  Whether or not this entry should be converted into an Anki note
52
52
 
@@ -60,7 +60,7 @@ Whether or not this entry should be converted into an Anki note
60
60
 
61
61
  > `optional` **externalInfo**: `true`
62
62
 
63
- Defined in: [types.ts:683](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L683)
63
+ Defined in: [types.ts:765](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L765)
64
64
 
65
65
  Whether or not this kanji object contains information extracted from [source](#source)
66
66
 
@@ -70,7 +70,7 @@ Whether or not this kanji object contains information extracted from [source](#s
70
70
 
71
71
  > `optional` **frequency**: `string`
72
72
 
73
- Defined in: [types.ts:667](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L667)
73
+ Defined in: [types.ts:749](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L749)
74
74
 
75
75
  #### See
76
76
 
@@ -82,7 +82,7 @@ Defined in: [types.ts:667](https://github.com/Ronokof/Henkan/blob/main/src/types
82
82
 
83
83
  > `optional` **grade**: `string`
84
84
 
85
- Defined in: [types.ts:663](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L663)
85
+ Defined in: [types.ts:745](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L745)
86
86
 
87
87
  #### See
88
88
 
@@ -94,7 +94,7 @@ Defined in: [types.ts:663](https://github.com/Ronokof/Henkan/blob/main/src/types
94
94
 
95
95
  > `optional` **id**: `` `${number}` ``
96
96
 
97
- Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
97
+ Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
98
98
 
99
99
  ID used for the Anki note ID
100
100
 
@@ -108,7 +108,7 @@ ID used for the Anki note ID
108
108
 
109
109
  > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
110
110
 
111
- Defined in: [types.ts:671](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L671)
111
+ Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L753)
112
112
 
113
113
  #### See
114
114
 
@@ -120,7 +120,7 @@ Defined in: [types.ts:671](https://github.com/Ronokof/Henkan/blob/main/src/types
120
120
 
121
121
  > `readonly` **kanji**: `string`
122
122
 
123
- Defined in: [types.ts:623](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L623)
123
+ Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L705)
124
124
 
125
125
  #### See
126
126
 
@@ -132,9 +132,9 @@ Defined in: [types.ts:623](https://github.com/Ronokof/Henkan/blob/main/src/types
132
132
 
133
133
  > `optional` **kokuji**: `true`
134
134
 
135
- Defined in: [types.ts:675](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L675)
135
+ Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L757)
136
136
 
137
- Whether or not the kanji is kokuji
137
+ Whether or not the kanji is a kokuji
138
138
 
139
139
  ***
140
140
 
@@ -142,7 +142,7 @@ Whether or not the kanji is kokuji
142
142
 
143
143
  > `optional` **kunyomi**: `string`[]
144
144
 
145
- Defined in: [types.ts:639](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L639)
145
+ Defined in: [types.ts:721](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L721)
146
146
 
147
147
  The kanji kunyomi readings
148
148
 
@@ -152,7 +152,7 @@ The kanji kunyomi readings
152
152
 
153
153
  > `optional` **meanings**: `string`[]
154
154
 
155
- Defined in: [types.ts:631](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L631)
155
+ Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L713)
156
156
 
157
157
  #### See
158
158
 
@@ -164,7 +164,7 @@ Defined in: [types.ts:631](https://github.com/Ronokof/Henkan/blob/main/src/types
164
164
 
165
165
  > `optional` **mnemonic**: `string`
166
166
 
167
- Defined in: [types.ts:655](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L655)
167
+ Defined in: [types.ts:737](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L737)
168
168
 
169
169
  The kanji mnemonic
170
170
 
@@ -174,7 +174,7 @@ The kanji mnemonic
174
174
 
175
175
  > `optional` **nanori**: `string`[]
176
176
 
177
- Defined in: [types.ts:643](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L643)
177
+ Defined in: [types.ts:725](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L725)
178
178
 
179
179
  #### See
180
180
 
@@ -186,7 +186,7 @@ Defined in: [types.ts:643](https://github.com/Ronokof/Henkan/blob/main/src/types
186
186
 
187
187
  > `optional` **noteID**: `string`
188
188
 
189
- Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
189
+ Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
190
190
 
191
191
  ID used for the resulting Anki note
192
192
 
@@ -200,7 +200,7 @@ ID used for the resulting Anki note
200
200
 
201
201
  > `optional` **noteTypeName**: `string`
202
202
 
203
- Defined in: [types.ts:511](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L511)
203
+ Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
204
204
 
205
205
  Anki note type name
206
206
 
@@ -214,7 +214,7 @@ Anki note type name
214
214
 
215
215
  > `optional` **onyomi**: `string`[]
216
216
 
217
- Defined in: [types.ts:635](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L635)
217
+ Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L717)
218
218
 
219
219
  The kanji onyomi readings
220
220
 
@@ -224,7 +224,7 @@ The kanji onyomi readings
224
224
 
225
225
  > `optional` **source**: `string`
226
226
 
227
- Defined in: [types.ts:679](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L679)
227
+ Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L761)
228
228
 
229
229
  The source (besides KANJIDIC) from which data for this kanji has been extracted
230
230
 
@@ -234,7 +234,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
234
234
 
235
235
  > `optional` **strokes**: `string`
236
236
 
237
- Defined in: [types.ts:627](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L627)
237
+ Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L709)
238
238
 
239
239
  #### See
240
240
 
@@ -246,7 +246,7 @@ Defined in: [types.ts:627](https://github.com/Ronokof/Henkan/blob/main/src/types
246
246
 
247
247
  > `optional` **svg**: `string`
248
248
 
249
- Defined in: [types.ts:647](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L647)
249
+ Defined in: [types.ts:729](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L729)
250
250
 
251
251
  The kanji SVG filename
252
252
 
@@ -256,7 +256,7 @@ The kanji SVG filename
256
256
 
257
257
  > `optional` **tags**: `string`[]
258
258
 
259
- Defined in: [types.ts:519](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L519)
259
+ Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
260
260
 
261
261
  Tags generated based on the entry's information
262
262
 
@@ -270,6 +270,6 @@ Tags generated based on the entry's information
270
270
 
271
271
  > `optional` **words**: [`Word`](Word.md)[]
272
272
 
273
- Defined in: [types.ts:659](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L659)
273
+ Defined in: [types.ts:741](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L741)
274
274
 
275
275
  Words that use the kanji
package/docs/api/interfaces/KanjiComponent.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiComponent
8
8
 
9
- Defined in: [types.ts:603](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L603)
9
+ Defined in: [types.ts:685](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L685)
10
10
 
11
11
  Kanji component information
12
12
 
@@ -16,7 +16,7 @@ Kanji component information
16
16
 
17
17
  > `readonly` **component**: `string`
18
18
 
19
- Defined in: [types.ts:607](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L607)
19
+ Defined in: [types.ts:689](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L689)
20
20
 
21
21
  The component character
22
22
 
@@ -26,6 +26,6 @@ The component character
26
26
 
27
27
  > `optional` **meaning**: `string`
28
28
 
29
- Defined in: [types.ts:611](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L611)
29
+ Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L693)
30
30
 
31
31
  The meaning of the component
package/docs/api/interfaces/KanjiForm.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiForm
8
8
 
9
- Defined in: [types.ts:545](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L545)
9
+ Defined in: [types.ts:627](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L627)
10
10
 
11
11
  A kanji form of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from a [DictKanjiForm](DictKanjiForm.md)
18
18
 
19
19
  > `optional` **common**: `true`
20
20
 
21
- Defined in: [types.ts:557](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L557)
21
+ Defined in: [types.ts:639](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L639)
22
22
 
23
23
  Whether or not the kanji form is common
24
24
 
@@ -28,7 +28,7 @@ Whether or not the kanji form is common
28
28
 
29
29
  > `readonly` **kanjiForm**: `string`
30
30
 
31
- Defined in: [types.ts:549](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L549)
31
+ Defined in: [types.ts:631](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L631)
32
32
 
33
33
  The kanji form
34
34
 
@@ -38,6 +38,6 @@ The kanji form
38
38
 
39
39
  > `optional` **notes**: `string`[]
40
40
 
41
- Defined in: [types.ts:553](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L553)
41
+ Defined in: [types.ts:635](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L635)
42
42
 
43
43
  Optional notes for the kanji form
package/docs/api/interfaces/NoteAndTag.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: NoteAndTag
8
8
 
9
- Defined in: [types.ts:529](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L529)
9
+ Defined in: [types.ts:611](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L611)
10
10
 
11
11
  A pair of a "kanji form"/"reading"/"sense" note and its associated tag
12
12
 
@@ -16,7 +16,7 @@ A pair of a "kanji form"/"reading"/"sense" note and its associated tag
16
16
 
17
17
  > `readonly` **note**: `string`
18
18
 
19
- Defined in: [types.ts:533](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L533)
19
+ Defined in: [types.ts:615](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L615)
20
20
 
21
21
  The note
22
22
 
@@ -26,6 +26,6 @@ The note
26
26
 
27
27
  > `readonly` `optional` **tag**: `string`
28
28
 
29
- Defined in: [types.ts:537](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L537)
29
+ Defined in: [types.ts:619](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L619)
30
30
 
31
31
  The tag
package/docs/api/interfaces/NoteHeaderKeys.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: NoteHeaderKeys
8
8
 
9
- Defined in: [types.ts:905](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L905)
9
+ Defined in: [types.ts:987](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L987)
10
10
 
11
11
  Anki note file headers keys
12
12
 
@@ -20,7 +20,7 @@ Anki note file headers keys
20
20
 
21
21
  > `readonly` **deck**: `` `${string}:` ``
22
22
 
23
- Defined in: [types.ts:925](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L925)
23
+ Defined in: [types.ts:1007](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1007)
24
24
 
25
25
  Deck name column header
26
26
 
@@ -30,7 +30,7 @@ Deck name column header
30
30
 
31
31
  > `readonly` **guid**: `` `${string}:` ``
32
32
 
33
- Defined in: [types.ts:917](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L917)
33
+ Defined in: [types.ts:999](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L999)
34
34
 
35
35
  GUID column header
36
36
 
@@ -40,7 +40,7 @@ GUID column header
40
40
 
41
41
  > `readonly` **html**: `` `${string}:false` `` \| `` `${string}:true` ``
42
42
 
43
- Defined in: [types.ts:913](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L913)
43
+ Defined in: [types.ts:995](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L995)
44
44
 
45
45
  HTML treatment
46
46
 
@@ -50,7 +50,7 @@ HTML treatment
50
50
 
51
51
  > `readonly` **notetype**: `` `${string}:` ``
52
52
 
53
- Defined in: [types.ts:921](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L921)
53
+ Defined in: [types.ts:1003](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1003)
54
54
 
55
55
  Note type column header
56
56
 
@@ -60,7 +60,7 @@ Note type column header
60
60
 
61
61
  > `readonly` **separator**: `` `${string}:${string}` ``
62
62
 
63
- Defined in: [types.ts:909](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L909)
63
+ Defined in: [types.ts:991](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L991)
64
64
 
65
65
  Field separator
66
66
 
@@ -70,6 +70,6 @@ Field separator
70
70
 
71
71
  > `readonly` **tags**: `` `${string}:` ``
72
72
 
73
- Defined in: [types.ts:929](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L929)
73
+ Defined in: [types.ts:1011](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1011)
74
74
 
75
75
  Tags column header (*must be completed with a number after `:`*)
package/docs/api/interfaces/Phrase.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Phrase
8
8
 
9
- Defined in: [types.ts:733](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L733)
9
+ Defined in: [types.ts:815](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L815)
10
10
 
11
11
  Phrase information
12
12
 
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
18
18
 
19
19
  > `readonly` `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
20
20
 
21
- Defined in: [types.ts:749](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L749)
21
+ Defined in: [types.ts:831](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L831)
22
22
 
23
23
  #### See
24
24
 
@@ -30,7 +30,7 @@ Defined in: [types.ts:749](https://github.com/Ronokof/Henkan/blob/main/src/types
30
30
 
31
31
  > `readonly` **originalPhrase**: `string`
32
32
 
33
- Defined in: [types.ts:745](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L745)
33
+ Defined in: [types.ts:827](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L827)
34
34
 
35
35
  #### See
36
36
 
@@ -42,7 +42,7 @@ Defined in: [types.ts:745](https://github.com/Ronokof/Henkan/blob/main/src/types
42
42
 
43
43
  > `readonly` **phrase**: `string`
44
44
 
45
- Defined in: [types.ts:737](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L737)
45
+ Defined in: [types.ts:819](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L819)
46
46
 
47
47
  The Japanese phrase, either with furigana attached or not
48
48
 
@@ -52,7 +52,7 @@ The Japanese phrase, either with furigana attached or not
52
52
 
53
53
  > `readonly` **translation**: `string`
54
54
 
55
- Defined in: [types.ts:741](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L741)
55
+ Defined in: [types.ts:823](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L823)
56
56
 
57
57
  #### See
58
58
 
package/docs/api/interfaces/Radical.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Radical
8
8
 
9
- Defined in: [types.ts:689](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L689)
9
+ Defined in: [types.ts:771](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L771)
10
10
 
11
11
  Kanji radical/component information
12
12
 
@@ -20,7 +20,7 @@ Kanji radical/component information
20
20
 
21
21
  > `optional` **deckPath**: `string`
22
22
 
23
- Defined in: [types.ts:515](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L515)
23
+ Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
24
24
 
25
25
  The full path of the Anki deck
26
26
 
@@ -34,7 +34,7 @@ The full path of the Anki deck
34
34
 
35
35
  > `optional` **doNotCreateNote**: `true`
36
36
 
37
- Defined in: [types.ts:523](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L523)
37
+ Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
38
38
 
39
39
  Whether or not this entry should be converted into an Anki note
40
40
 
@@ -48,7 +48,7 @@ Whether or not this entry should be converted into an Anki note
48
48
 
49
49
  > `optional` **externalInfo**: `true`
50
50
 
51
- Defined in: [types.ts:725](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L725)
51
+ Defined in: [types.ts:807](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L807)
52
52
 
53
53
  Whether or not this radical/component object contains information extracted from [sources](#sources)
54
54
 
@@ -58,7 +58,7 @@ Whether or not this radical/component object contains information extracted from
58
58
 
59
59
  > `optional` **id**: `` `${number}` ``
60
60
 
61
- Defined in: [types.ts:507](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L507)
61
+ Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
62
62
 
63
63
  ID used for the Anki note ID
64
64
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
72
72
 
73
73
  > `optional` **kanji**: [`Kanji`](Kanji.md)[]
74
74
 
75
- Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L717)
75
+ Defined in: [types.ts:799](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L799)
76
76
 
77
77
  Kanji that include the radical/component
78
78
 
@@ -82,7 +82,7 @@ Kanji that include the radical/component
82
82
 
83
83
  > **meanings**: `string`[]
84
84
 
85
- Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L701)
85
+ Defined in: [types.ts:783](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L783)
86
86
 
87
87
  The radical/component meanings
88
88
 
@@ -92,7 +92,7 @@ The radical/component meanings
92
92
 
93
93
  > `optional` **mnemonic**: `string`
94
94
 
95
- Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L713)
95
+ Defined in: [types.ts:795](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L795)
96
96
 
97
97
  The radical/component mnemonic
98
98
 
@@ -102,7 +102,7 @@ The radical/component mnemonic
102
102
 
103
103
  > `optional` **noteID**: `string`
104
104
 
105
- Defined in: [types.ts:503](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L503)
105
+ Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
106
106
 
107
107
  ID used for the resulting Anki note
108
108
 
@@ -116,7 +116,7 @@ ID used for the resulting Anki note
116
116
 
117
117
  > `optional` **noteTypeName**: `string`
118
118
 
119
- Defined in: [types.ts:511](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L511)
119
+ Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
120
120
 
121
121
  Anki note type name
122
122
 
@@ -130,7 +130,7 @@ Anki note type name
130
130
 
131
131
  > `readonly` **radical**: `string`
132
132
 
133
- Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L693)
133
+ Defined in: [types.ts:775](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L775)
134
134
 
135
135
  The radical/component character
136
136
 
@@ -140,7 +140,7 @@ The radical/component character
140
140
 
141
141
  > **reading**: `string`
142
142
 
143
- Defined in: [types.ts:697](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L697)
143
+ Defined in: [types.ts:779](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L779)
144
144
 
145
145
  The radical/component reading (in kana)
146
146
 
@@ -150,7 +150,7 @@ The radical/component reading (in kana)
150
150
 
151
151
  > `optional` **sources**: `string`[]
152
152
 
153
- Defined in: [types.ts:721](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L721)
153
+ Defined in: [types.ts:803](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L803)
154
154
 
155
155
  The sources from which data for this radical/component has been extracted
156
156
 
@@ -160,7 +160,7 @@ The sources from which data for this radical/component has been extracted
160
160
 
161
161
  > `optional` **strokes**: `string`
162
162
 
163
- Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L705)
163
+ Defined in: [types.ts:787](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L787)
164
164
 
165
165
  The stroke count of the radical/component
166
166
 
@@ -170,7 +170,7 @@ The stroke count of the radical/component
170
170
 
171
171
  > `optional` **svg**: `string`
172
172
 
173
- Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L709)
173
+ Defined in: [types.ts:791](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L791)
174
174
 
175
175
  The radical/component SVG filename
176
176
 
@@ -180,7 +180,7 @@ The radical/component SVG filename
180
180
 
181
181
  > `optional` **tags**: `string`[]
182
182
 
183
- Defined in: [types.ts:519](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L519)
183
+ Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
184
184
 
185
185
  Tags generated based on the entry's information
186
186