henkan 1.0.2 → 1.1.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 (63) hide show
  1. package/dist/index.cjs.js +10 -6
  2. package/dist/index.cjs.js.map +2 -2
  3. package/dist/index.mjs +7 -3
  4. package/dist/index.mjs.map +2 -2
  5. package/dist/types/types.d.ts +10 -6
  6. package/dist/types/types.d.ts.map +1 -1
  7. package/dist/types/utils.d.ts +2 -2
  8. package/dist/types/utils.d.ts.map +1 -1
  9. package/docs/api/functions/capitalizeString.md +1 -1
  10. package/docs/api/functions/convertJMdict.md +1 -1
  11. package/docs/api/functions/convertJawiktionary.md +2 -2
  12. package/docs/api/functions/convertKanjiDic.md +1 -1
  13. package/docs/api/functions/convertKradFile.md +1 -1
  14. package/docs/api/functions/convertRadkFile.md +1 -1
  15. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  16. package/docs/api/functions/generateAnkiNote.md +1 -1
  17. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  18. package/docs/api/functions/getKanji.md +1 -1
  19. package/docs/api/functions/getKanjiExtended.md +1 -1
  20. package/docs/api/functions/getWord.md +1 -1
  21. package/docs/api/functions/getWordDefinitions.md +1 -1
  22. package/docs/api/functions/isStringArray.md +1 -1
  23. package/docs/api/functions/isValidArray.md +1 -1
  24. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  25. package/docs/api/functions/shuffleArray.md +1 -1
  26. package/docs/api/functions/synthesizeSpeech.md +2 -2
  27. package/docs/api/interfaces/Definition.md +4 -4
  28. package/docs/api/interfaces/DictKanji.md +5 -5
  29. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  30. package/docs/api/interfaces/DictKanjiMisc.md +10 -10
  31. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  32. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  33. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  34. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  35. package/docs/api/interfaces/DictMeaning.md +11 -11
  36. package/docs/api/interfaces/DictRadical.md +4 -4
  37. package/docs/api/interfaces/DictReading.md +5 -5
  38. package/docs/api/interfaces/DictWord.md +8 -8
  39. package/docs/api/interfaces/ExamplePart.md +7 -7
  40. package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
  41. package/docs/api/interfaces/Grammar.md +16 -16
  42. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  43. package/docs/api/interfaces/Kana.md +11 -11
  44. package/docs/api/interfaces/Kanji.md +34 -22
  45. package/docs/api/interfaces/KanjiComponent.md +3 -3
  46. package/docs/api/interfaces/KanjiForm.md +4 -4
  47. package/docs/api/interfaces/NoteAndTag.md +3 -3
  48. package/docs/api/interfaces/Phrase.md +5 -5
  49. package/docs/api/interfaces/Radical.md +16 -16
  50. package/docs/api/interfaces/Reading.md +5 -5
  51. package/docs/api/interfaces/ResultEntry.md +7 -7
  52. package/docs/api/interfaces/TanakaExample.md +7 -7
  53. package/docs/api/interfaces/Translation.md +3 -3
  54. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  55. package/docs/api/interfaces/Word.md +15 -15
  56. package/docs/api/interfaces/WordDefinitionPair.md +3 -3
  57. package/docs/api/type-aliases/Dict.md +1 -1
  58. package/docs/api/type-aliases/DictName.md +1 -1
  59. package/docs/api/type-aliases/DictTranslation.md +1 -1
  60. package/docs/api/type-aliases/EntryType.md +1 -1
  61. package/docs/api/type-aliases/JLPT.md +1 -1
  62. package/docs/api/type-aliases/Result.md +1 -1
  63. package/package.json +3 -3
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kanji
8
8
 
9
- Defined in: [types.ts:551](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L551)
9
+ Defined in: [types.ts:551](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L551)
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:583](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L583)
25
+ Defined in: [types.ts:583](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L583)
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:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
35
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
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:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
49
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
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` **frequency**: `string`
62
62
 
63
- Defined in: [types.ts:599](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L599)
63
+ Defined in: [types.ts:599](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L599)
64
64
 
65
65
  #### See
66
66
 
@@ -72,7 +72,7 @@ Defined in: [types.ts:599](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
72
72
 
73
73
  > `optional` **fromJpdb**: `true`
74
74
 
75
- Defined in: [types.ts:611](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L611)
75
+ Defined in: [types.ts:615](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L615)
76
76
 
77
77
  Whether or not this kanji object contains information **only** from `jpdb.io`
78
78
 
@@ -82,7 +82,7 @@ Whether or not this kanji object contains information **only** from `jpdb.io`
82
82
 
83
83
  > `optional` **grade**: `string`
84
84
 
85
- Defined in: [types.ts:595](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L595)
85
+ Defined in: [types.ts:595](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L595)
86
86
 
87
87
  #### See
88
88
 
@@ -94,7 +94,7 @@ Defined in: [types.ts:595](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
94
94
 
95
95
  > `readonly` `optional` **id**: `string`
96
96
 
97
- Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
97
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L439)
98
98
 
99
99
  ID used for the Anki note ID
100
100
 
@@ -104,11 +104,23 @@ ID used for the Anki note ID
104
104
 
105
105
  ***
106
106
 
107
+ ### jlpt?
108
+
109
+ > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
110
+
111
+ Defined in: [types.ts:603](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L603)
112
+
113
+ #### See
114
+
115
+ [DictKanjiMisc.jlpt](DictKanjiMisc.md#jlpt)
116
+
117
+ ***
118
+
107
119
  ### kanji
108
120
 
109
121
  > `readonly` **kanji**: `string`
110
122
 
111
- Defined in: [types.ts:555](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L555)
123
+ Defined in: [types.ts:555](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L555)
112
124
 
113
125
  #### See
114
126
 
@@ -120,7 +132,7 @@ Defined in: [types.ts:555](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
120
132
 
121
133
  > `optional` **kokuji**: `true`
122
134
 
123
- Defined in: [types.ts:603](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L603)
135
+ Defined in: [types.ts:607](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L607)
124
136
 
125
137
  Whether or not the kanji is kokuji
126
138
 
@@ -130,7 +142,7 @@ Whether or not the kanji is kokuji
130
142
 
131
143
  > `optional` **kunyomi**: `string`[]
132
144
 
133
- Defined in: [types.ts:571](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L571)
145
+ Defined in: [types.ts:571](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L571)
134
146
 
135
147
  The kanji kunyomi readings
136
148
 
@@ -140,7 +152,7 @@ The kanji kunyomi readings
140
152
 
141
153
  > `optional` **meanings**: `string`[]
142
154
 
143
- Defined in: [types.ts:563](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L563)
155
+ Defined in: [types.ts:563](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L563)
144
156
 
145
157
  #### See
146
158
 
@@ -152,7 +164,7 @@ Defined in: [types.ts:563](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
152
164
 
153
165
  > `optional` **mnemonic**: `string`
154
166
 
155
- Defined in: [types.ts:587](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L587)
167
+ Defined in: [types.ts:587](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L587)
156
168
 
157
169
  The kanji mnemonic
158
170
 
@@ -162,7 +174,7 @@ The kanji mnemonic
162
174
 
163
175
  > `optional` **nanori**: `string`[]
164
176
 
165
- Defined in: [types.ts:575](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L575)
177
+ Defined in: [types.ts:575](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L575)
166
178
 
167
179
  #### See
168
180
 
@@ -174,7 +186,7 @@ Defined in: [types.ts:575](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
174
186
 
175
187
  > `readonly` `optional` **noteID**: `` `kanji_${string}` ``
176
188
 
177
- Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
189
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L435)
178
190
 
179
191
  ID used for the resulting Anki note
180
192
 
@@ -188,7 +200,7 @@ ID used for the resulting Anki note
188
200
 
189
201
  > `optional` **noteTypeName**: `string`
190
202
 
191
- Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
203
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
192
204
 
193
205
  Anki note type name
194
206
 
@@ -202,7 +214,7 @@ Anki note type name
202
214
 
203
215
  > `optional` **onyomi**: `string`[]
204
216
 
205
- Defined in: [types.ts:567](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L567)
217
+ Defined in: [types.ts:567](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L567)
206
218
 
207
219
  The kanji onyomi readings
208
220
 
@@ -212,7 +224,7 @@ The kanji onyomi readings
212
224
 
213
225
  > `optional` **source**: `string`
214
226
 
215
- Defined in: [types.ts:607](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L607)
227
+ Defined in: [types.ts:611](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L611)
216
228
 
217
229
  The source (besides KANJIDIC) from which data for this kanji has been extracted
218
230
 
@@ -222,7 +234,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
222
234
 
223
235
  > `optional` **strokes**: `string`
224
236
 
225
- Defined in: [types.ts:559](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L559)
237
+ Defined in: [types.ts:559](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L559)
226
238
 
227
239
  #### See
228
240
 
@@ -234,7 +246,7 @@ Defined in: [types.ts:559](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
234
246
 
235
247
  > `optional` **svg**: `string`
236
248
 
237
- Defined in: [types.ts:579](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L579)
249
+ Defined in: [types.ts:579](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L579)
238
250
 
239
251
  The kanji SVG filename
240
252
 
@@ -244,7 +256,7 @@ The kanji SVG filename
244
256
 
245
257
  > `optional` **tags**: `string`[]
246
258
 
247
- Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
259
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
248
260
 
249
261
  Tags generated based on the entry's information
250
262
 
@@ -258,6 +270,6 @@ Tags generated based on the entry's information
258
270
 
259
271
  > `optional` **words**: [`Word`](Word.md)[]
260
272
 
261
- Defined in: [types.ts:591](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L591)
273
+ Defined in: [types.ts:591](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L591)
262
274
 
263
275
  Words that use the kanji
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiComponent
8
8
 
9
- Defined in: [types.ts:535](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L535)
9
+ Defined in: [types.ts:535](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L535)
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:539](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L539)
19
+ Defined in: [types.ts:539](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L539)
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:543](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L543)
29
+ Defined in: [types.ts:543](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L543)
30
30
 
31
31
  The meaning of the component
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiForm
8
8
 
9
- Defined in: [types.ts:477](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L477)
9
+ Defined in: [types.ts:477](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L477)
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:489](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L489)
21
+ Defined in: [types.ts:489](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L489)
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:481](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L481)
31
+ Defined in: [types.ts:481](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L481)
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:485](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L485)
41
+ Defined in: [types.ts:485](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L485)
42
42
 
43
43
  Optional notes for the kanji form
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: NoteAndTag
8
8
 
9
- Defined in: [types.ts:461](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L461)
9
+ Defined in: [types.ts:461](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L461)
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` `optional` **note**: `string`
18
18
 
19
- Defined in: [types.ts:465](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L465)
19
+ Defined in: [types.ts:465](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L465)
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:469](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L469)
29
+ Defined in: [types.ts:469](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L469)
30
30
 
31
31
  The tag
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Phrase
8
8
 
9
- Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L661)
9
+ Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L665)
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:677](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L677)
21
+ Defined in: [types.ts:681](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L681)
22
22
 
23
23
  #### See
24
24
 
@@ -30,7 +30,7 @@ Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
30
30
 
31
31
  > `readonly` **originalPhrase**: `string`
32
32
 
33
- Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L673)
33
+ Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L677)
34
34
 
35
35
  #### See
36
36
 
@@ -42,7 +42,7 @@ Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f7
42
42
 
43
43
  > `readonly` **phrase**: `string`
44
44
 
45
- Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L665)
45
+ Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L669)
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:669](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L669)
55
+ Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L673)
56
56
 
57
57
  #### See
58
58
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Radical
8
8
 
9
- Defined in: [types.ts:617](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L617)
9
+ Defined in: [types.ts:621](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L621)
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:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
23
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
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:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
37
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
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` **fromJpdb**: `true`
50
50
 
51
- Defined in: [types.ts:653](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L653)
51
+ Defined in: [types.ts:657](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L657)
52
52
 
53
53
  Whether or not this radical/component object contains information **only** from `jpdb.io`
54
54
 
@@ -58,7 +58,7 @@ Whether or not this radical/component object contains information **only** from
58
58
 
59
59
  > `readonly` `optional` **id**: `string`
60
60
 
61
- Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
61
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L439)
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:645](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L645)
75
+ Defined in: [types.ts:649](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L649)
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:629](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L629)
85
+ Defined in: [types.ts:633](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L633)
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:641](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L641)
95
+ Defined in: [types.ts:645](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L645)
96
96
 
97
97
  The radical/component mnemonic
98
98
 
@@ -102,7 +102,7 @@ The radical/component mnemonic
102
102
 
103
103
  > `readonly` `optional` **noteID**: `` `radical_${string}` ``
104
104
 
105
- Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
105
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L435)
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:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
119
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
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:621](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L621)
133
+ Defined in: [types.ts:625](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L625)
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:625](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L625)
143
+ Defined in: [types.ts:629](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L629)
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:649](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L649)
153
+ Defined in: [types.ts:653](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L653)
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:633](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L633)
163
+ Defined in: [types.ts:637](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L637)
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:637](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L637)
173
+ Defined in: [types.ts:641](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L641)
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:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
183
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
184
184
 
185
185
  Tags generated based on the entry's information
186
186
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Reading
8
8
 
9
- Defined in: [types.ts:497](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L497)
9
+ Defined in: [types.ts:497](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L497)
10
10
 
11
11
  A reading of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from [DictReading](DictReading.md)
18
18
 
19
19
  > `optional` **audio**: `string`
20
20
 
21
- Defined in: [types.ts:513](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L513)
21
+ Defined in: [types.ts:513](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L513)
22
22
 
23
23
  The filename of an audio file for the reading
24
24
 
@@ -28,7 +28,7 @@ The filename of an audio file for the reading
28
28
 
29
29
  > `optional` **common**: `true`
30
30
 
31
- Defined in: [types.ts:509](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L509)
31
+ Defined in: [types.ts:509](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L509)
32
32
 
33
33
  Whether or not the reading is common
34
34
 
@@ -38,7 +38,7 @@ Whether or not the reading is common
38
38
 
39
39
  > `optional` **notes**: `string`[]
40
40
 
41
- Defined in: [types.ts:505](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L505)
41
+ Defined in: [types.ts:505](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L505)
42
42
 
43
43
  Optional notes for the reading
44
44
 
@@ -48,6 +48,6 @@ Optional notes for the reading
48
48
 
49
49
  > `readonly` **reading**: `string`
50
50
 
51
- Defined in: [types.ts:501](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L501)
51
+ Defined in: [types.ts:501](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L501)
52
52
 
53
53
  The reading (in kana)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ResultEntry\<EntryType\>
8
8
 
9
- Defined in: [types.ts:431](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L431)
9
+ Defined in: [types.ts:431](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L431)
10
10
 
11
11
  Basic Anki note information
12
12
 
@@ -30,7 +30,7 @@ Basic Anki note information
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
33
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
34
34
 
35
35
  The full path of the Anki deck
36
36
 
@@ -40,7 +40,7 @@ The full path of the Anki deck
40
40
 
41
41
  > `optional` **doNotCreateNote**: `true`
42
42
 
43
- Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
43
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
44
44
 
45
45
  Whether or not this entry should be converted into an Anki note
46
46
 
@@ -50,7 +50,7 @@ Whether or not this entry should be converted into an Anki note
50
50
 
51
51
  > `readonly` `optional` **id**: `string`
52
52
 
53
- Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
53
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L439)
54
54
 
55
55
  ID used for the Anki note ID
56
56
 
@@ -60,7 +60,7 @@ ID used for the Anki note ID
60
60
 
61
61
  > `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
62
62
 
63
- Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
63
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L435)
64
64
 
65
65
  ID used for the resulting Anki note
66
66
 
@@ -70,7 +70,7 @@ ID used for the resulting Anki note
70
70
 
71
71
  > `optional` **noteTypeName**: `string`
72
72
 
73
- Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
73
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
74
74
 
75
75
  Anki note type name
76
76
 
@@ -80,6 +80,6 @@ Anki note type name
80
80
 
81
81
  > `optional` **tags**: `string`[]
82
82
 
83
- Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
83
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
84
84
 
85
85
  Tags generated based on the entry's information
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: TanakaExample
8
8
 
9
- Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L353)
9
+ Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L353)
10
10
 
11
11
  Tanaka Corpus `examples.utf` examples
12
12
 
@@ -16,7 +16,7 @@ Tanaka Corpus `examples.utf` examples
16
16
 
17
17
  > `readonly` `optional` **furigana**: `string`
18
18
 
19
- Defined in: [types.ts:373](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L373)
19
+ Defined in: [types.ts:373](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L373)
20
20
 
21
21
  The Japanese phrase, with furigana attached
22
22
 
@@ -26,7 +26,7 @@ The Japanese phrase, with furigana attached
26
26
 
27
27
  > `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
28
28
 
29
- Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L377)
29
+ Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L377)
30
30
 
31
31
  The word-gloss pair
32
32
 
@@ -36,7 +36,7 @@ The word-gloss pair
36
36
 
37
37
  > `readonly` **id**: `` `${number}_${number}` ``
38
38
 
39
- Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L357)
39
+ Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L357)
40
40
 
41
41
  The ID of the example
42
42
 
@@ -46,7 +46,7 @@ The ID of the example
46
46
 
47
47
  > `readonly` **parts**: [`ExamplePart`](ExamplePart.md)[]
48
48
 
49
- Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L369)
49
+ Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L369)
50
50
 
51
51
  The `B` section, split into parts
52
52
 
@@ -56,7 +56,7 @@ The `B` section, split into parts
56
56
 
57
57
  > `readonly` **phrase**: `string`
58
58
 
59
- Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L361)
59
+ Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L361)
60
60
 
61
61
  The Japanese phrase (found in the `A` section, **before** the tab)
62
62
 
@@ -66,6 +66,6 @@ The Japanese phrase (found in the `A` section, **before** the tab)
66
66
 
67
67
  > `readonly` **translation**: `string`
68
68
 
69
- Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L365)
69
+ Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L365)
70
70
 
71
71
  The English translation of the phrase (found in the `A` section, **after** the tab)