henkan 0.1.0 → 0.1.2

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 (57) hide show
  1. package/dist/index.cjs.js +43 -5
  2. package/dist/index.cjs.js.map +3 -3
  3. package/dist/index.mjs +43 -5
  4. package/dist/index.mjs.map +3 -3
  5. package/dist/types/types.d.ts +14 -0
  6. package/dist/types/types.d.ts.map +1 -1
  7. package/dist/types/utils.d.ts +2 -1
  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 +8 -2
  11. package/docs/api/functions/convertKanjiDic.md +1 -1
  12. package/docs/api/functions/convertKradFile.md +1 -1
  13. package/docs/api/functions/convertRadkFile.md +1 -1
  14. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  15. package/docs/api/functions/generateAnkiNote.md +1 -1
  16. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  17. package/docs/api/functions/getKanji.md +1 -1
  18. package/docs/api/functions/getKanjiExtended.md +1 -1
  19. package/docs/api/functions/getWord.md +1 -1
  20. package/docs/api/functions/isStringArray.md +1 -1
  21. package/docs/api/functions/isValidArray.md +1 -1
  22. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  23. package/docs/api/functions/makeSSML.md +1 -1
  24. package/docs/api/functions/shuffleArray.md +1 -1
  25. package/docs/api/functions/synthesizeSpeech.md +1 -1
  26. package/docs/api/interfaces/DictKanji.md +4 -4
  27. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  28. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  29. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  30. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  31. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  32. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  33. package/docs/api/interfaces/DictMeaning.md +11 -11
  34. package/docs/api/interfaces/DictRadical.md +4 -4
  35. package/docs/api/interfaces/DictReading.md +5 -5
  36. package/docs/api/interfaces/DictWord.md +27 -5
  37. package/docs/api/interfaces/ExamplePart.md +7 -7
  38. package/docs/api/interfaces/Grammar.md +28 -14
  39. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  40. package/docs/api/interfaces/Kana.md +24 -10
  41. package/docs/api/interfaces/Kanji.md +34 -20
  42. package/docs/api/interfaces/KanjiComponent.md +3 -3
  43. package/docs/api/interfaces/KanjiForm.md +3 -3
  44. package/docs/api/interfaces/Phrase.md +4 -4
  45. package/docs/api/interfaces/Radical.md +29 -15
  46. package/docs/api/interfaces/Reading.md +4 -4
  47. package/docs/api/interfaces/ResultEntry.md +16 -6
  48. package/docs/api/interfaces/TanakaExample.md +5 -5
  49. package/docs/api/interfaces/Translation.md +3 -3
  50. package/docs/api/interfaces/UsefulRegExps.md +9 -9
  51. package/docs/api/interfaces/Word.md +27 -13
  52. package/docs/api/type-aliases/Dict.md +1 -1
  53. package/docs/api/type-aliases/DictName.md +1 -1
  54. package/docs/api/type-aliases/EntryType.md +1 -1
  55. package/docs/api/type-aliases/JLPT.md +1 -1
  56. package/docs/api/type-aliases/Result.md +1 -1
  57. package/package.json +2 -2
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kanji
8
8
 
9
- Defined in: [types.ts:444](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L444)
9
+ Defined in: [types.ts:458](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L458)
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:476](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L476)
25
+ Defined in: [types.ts:490](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L490)
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:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
35
+ Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L376)
36
36
 
37
37
  The full path of the Anki deck
38
38
 
@@ -42,11 +42,25 @@ The full path of the Anki deck
42
42
 
43
43
  ***
44
44
 
45
+ ### doNotCreateNote?
46
+
47
+ > `optional` **doNotCreateNote**: `true`
48
+
49
+ Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L384)
50
+
51
+ Whether or not this entry should be converted into an Anki note
52
+
53
+ #### Inherited from
54
+
55
+ [`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
56
+
57
+ ***
58
+
45
59
  ### frequency?
46
60
 
47
61
  > `optional` **frequency**: `string`
48
62
 
49
- Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L492)
63
+ Defined in: [types.ts:506](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L506)
50
64
 
51
65
  #### See
52
66
 
@@ -58,7 +72,7 @@ Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
58
72
 
59
73
  > `optional` **fromJpdb**: `true`
60
74
 
61
- Defined in: [types.ts:500](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L500)
75
+ Defined in: [types.ts:514](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L514)
62
76
 
63
77
  Whether or not this kanji object contains information **only** from `jpdb.io`
64
78
 
@@ -68,7 +82,7 @@ Whether or not this kanji object contains information **only** from `jpdb.io`
68
82
 
69
83
  > `optional` **grade**: `string`
70
84
 
71
- Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L488)
85
+ Defined in: [types.ts:502](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L502)
72
86
 
73
87
  #### See
74
88
 
@@ -80,7 +94,7 @@ Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
80
94
 
81
95
  > `readonly` `optional` **id**: `string`
82
96
 
83
- Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
97
+ Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L368)
84
98
 
85
99
  ID used for the Anki note ID
86
100
 
@@ -94,7 +108,7 @@ ID used for the Anki note ID
94
108
 
95
109
  > `readonly` **kanji**: `string`
96
110
 
97
- Defined in: [types.ts:448](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L448)
111
+ Defined in: [types.ts:462](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L462)
98
112
 
99
113
  #### See
100
114
 
@@ -106,7 +120,7 @@ Defined in: [types.ts:448](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
106
120
 
107
121
  > `optional` **kunyomi**: `string`[]
108
122
 
109
- Defined in: [types.ts:464](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L464)
123
+ Defined in: [types.ts:478](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L478)
110
124
 
111
125
  The kanji kunyomi readings
112
126
 
@@ -116,7 +130,7 @@ The kanji kunyomi readings
116
130
 
117
131
  > `optional` **meanings**: `string`[]
118
132
 
119
- Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L456)
133
+ Defined in: [types.ts:470](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L470)
120
134
 
121
135
  #### See
122
136
 
@@ -128,7 +142,7 @@ Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
128
142
 
129
143
  > `optional` **mnemonic**: `string`
130
144
 
131
- Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L480)
145
+ Defined in: [types.ts:494](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L494)
132
146
 
133
147
  The kanji mnemonic
134
148
 
@@ -138,7 +152,7 @@ The kanji mnemonic
138
152
 
139
153
  > `optional` **nanori**: `string`[]
140
154
 
141
- Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L468)
155
+ Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L482)
142
156
 
143
157
  #### See
144
158
 
@@ -150,7 +164,7 @@ Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
150
164
 
151
165
  > `readonly` `optional` **noteID**: `` `kanji_${string}` ``
152
166
 
153
- Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
167
+ Defined in: [types.ts:364](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L364)
154
168
 
155
169
  ID used for the resulting Anki note
156
170
 
@@ -164,7 +178,7 @@ ID used for the resulting Anki note
164
178
 
165
179
  > `optional` **noteTypeName**: `string`
166
180
 
167
- Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
181
+ Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L372)
168
182
 
169
183
  Anki note type name
170
184
 
@@ -178,7 +192,7 @@ Anki note type name
178
192
 
179
193
  > `optional` **onyomi**: `string`[]
180
194
 
181
- Defined in: [types.ts:460](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L460)
195
+ Defined in: [types.ts:474](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L474)
182
196
 
183
197
  The kanji onyomi readings
184
198
 
@@ -188,7 +202,7 @@ The kanji onyomi readings
188
202
 
189
203
  > `optional` **source**: `string`
190
204
 
191
- Defined in: [types.ts:496](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L496)
205
+ Defined in: [types.ts:510](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L510)
192
206
 
193
207
  The source (besides KANJIDIC) from which data for this kanji has been extracted
194
208
 
@@ -198,7 +212,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
198
212
 
199
213
  > `optional` **strokes**: `string`
200
214
 
201
- Defined in: [types.ts:452](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L452)
215
+ Defined in: [types.ts:466](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L466)
202
216
 
203
217
  #### See
204
218
 
@@ -210,7 +224,7 @@ Defined in: [types.ts:452](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
210
224
 
211
225
  > `optional` **svg**: `string`
212
226
 
213
- Defined in: [types.ts:472](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L472)
227
+ Defined in: [types.ts:486](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L486)
214
228
 
215
229
  The kanji SVG filename
216
230
 
@@ -220,7 +234,7 @@ The kanji SVG filename
220
234
 
221
235
  > `optional` **tags**: `string`[]
222
236
 
223
- Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
237
+ Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L380)
224
238
 
225
239
  Tags generated based on the entry's information
226
240
 
@@ -234,6 +248,6 @@ Tags generated based on the entry's information
234
248
 
235
249
  > `optional` **words**: [`Word`](Word.md)[]
236
250
 
237
- Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L484)
251
+ Defined in: [types.ts:498](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L498)
238
252
 
239
253
  Words that use the kanji
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiComponent
8
8
 
9
- Defined in: [types.ts:428](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L428)
9
+ Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L442)
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:432](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L432)
19
+ Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L446)
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:436](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L436)
29
+ Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L450)
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:378](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L378)
9
+ Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L392)
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
  > `readonly` **kanjiForm**: `string`
20
20
 
21
- Defined in: [types.ts:382](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L382)
21
+ Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L396)
22
22
 
23
23
  The kanji form
24
24
 
@@ -28,6 +28,6 @@ The kanji form
28
28
 
29
29
  > `optional` **notes**: `string`[]
30
30
 
31
- Defined in: [types.ts:386](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L386)
31
+ Defined in: [types.ts:400](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L400)
32
32
 
33
33
  Optional notes for the kanji form
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Phrase
8
8
 
9
- Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L550)
9
+ Defined in: [types.ts:564](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L564)
10
10
 
11
11
  Phrase information
12
12
 
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
18
18
 
19
19
  > `readonly` **originalPhrase**: `string`
20
20
 
21
- Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L562)
21
+ Defined in: [types.ts:576](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L576)
22
22
 
23
23
  #### See
24
24
 
@@ -30,7 +30,7 @@ Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15
30
30
 
31
31
  > `readonly` **phrase**: `string`
32
32
 
33
- Defined in: [types.ts:554](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L554)
33
+ Defined in: [types.ts:568](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L568)
34
34
 
35
35
  The Japanese phrase, either with furigana attached or not
36
36
 
@@ -40,7 +40,7 @@ The Japanese phrase, either with furigana attached or not
40
40
 
41
41
  > `readonly` **translation**: `string`
42
42
 
43
- Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L558)
43
+ Defined in: [types.ts:572](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L572)
44
44
 
45
45
  #### See
46
46
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Radical
8
8
 
9
- Defined in: [types.ts:506](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L506)
9
+ Defined in: [types.ts:520](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L520)
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:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
23
+ Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L376)
24
24
 
25
25
  The full path of the Anki deck
26
26
 
@@ -30,11 +30,25 @@ The full path of the Anki deck
30
30
 
31
31
  ***
32
32
 
33
+ ### doNotCreateNote?
34
+
35
+ > `optional` **doNotCreateNote**: `true`
36
+
37
+ Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L384)
38
+
39
+ Whether or not this entry should be converted into an Anki note
40
+
41
+ #### Inherited from
42
+
43
+ [`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
44
+
45
+ ***
46
+
33
47
  ### fromJpdb?
34
48
 
35
49
  > `optional` **fromJpdb**: `true`
36
50
 
37
- Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L542)
51
+ Defined in: [types.ts:556](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L556)
38
52
 
39
53
  Whether or not this radical/component object contains information **only** from `jpdb.io`
40
54
 
@@ -44,7 +58,7 @@ Whether or not this radical/component object contains information **only** from
44
58
 
45
59
  > `readonly` `optional` **id**: `string`
46
60
 
47
- Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
61
+ Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L368)
48
62
 
49
63
  ID used for the Anki note ID
50
64
 
@@ -58,7 +72,7 @@ ID used for the Anki note ID
58
72
 
59
73
  > `optional` **kanji**: [`Kanji`](Kanji.md)[]
60
74
 
61
- Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L534)
75
+ Defined in: [types.ts:548](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L548)
62
76
 
63
77
  Kanji that include the radical/component
64
78
 
@@ -68,7 +82,7 @@ Kanji that include the radical/component
68
82
 
69
83
  > **meanings**: `string`[]
70
84
 
71
- Defined in: [types.ts:518](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L518)
85
+ Defined in: [types.ts:532](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L532)
72
86
 
73
87
  The radical/component meanings
74
88
 
@@ -78,7 +92,7 @@ The radical/component meanings
78
92
 
79
93
  > `optional` **mnemonic**: `string`
80
94
 
81
- Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L530)
95
+ Defined in: [types.ts:544](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L544)
82
96
 
83
97
  The radical/component mnemonic
84
98
 
@@ -88,7 +102,7 @@ The radical/component mnemonic
88
102
 
89
103
  > `readonly` `optional` **noteID**: `` `radical_${string}` ``
90
104
 
91
- Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
105
+ Defined in: [types.ts:364](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L364)
92
106
 
93
107
  ID used for the resulting Anki note
94
108
 
@@ -102,7 +116,7 @@ ID used for the resulting Anki note
102
116
 
103
117
  > `optional` **noteTypeName**: `string`
104
118
 
105
- Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
119
+ Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L372)
106
120
 
107
121
  Anki note type name
108
122
 
@@ -116,7 +130,7 @@ Anki note type name
116
130
 
117
131
  > `readonly` **radical**: `string`
118
132
 
119
- Defined in: [types.ts:510](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L510)
133
+ Defined in: [types.ts:524](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L524)
120
134
 
121
135
  The radical/component character
122
136
 
@@ -126,7 +140,7 @@ The radical/component character
126
140
 
127
141
  > **reading**: `string`
128
142
 
129
- Defined in: [types.ts:514](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L514)
143
+ Defined in: [types.ts:528](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L528)
130
144
 
131
145
  The radical/component reading (in kana)
132
146
 
@@ -136,7 +150,7 @@ The radical/component reading (in kana)
136
150
 
137
151
  > `optional` **sources**: `string`[]
138
152
 
139
- Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L538)
153
+ Defined in: [types.ts:552](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L552)
140
154
 
141
155
  The sources from which data for this radical/component has been extracted
142
156
 
@@ -146,7 +160,7 @@ The sources from which data for this radical/component has been extracted
146
160
 
147
161
  > `optional` **strokes**: `string`
148
162
 
149
- Defined in: [types.ts:522](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L522)
163
+ Defined in: [types.ts:536](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L536)
150
164
 
151
165
  The stroke count of the radical/component
152
166
 
@@ -156,7 +170,7 @@ The stroke count of the radical/component
156
170
 
157
171
  > `optional` **svg**: `string`
158
172
 
159
- Defined in: [types.ts:526](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L526)
173
+ Defined in: [types.ts:540](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L540)
160
174
 
161
175
  The radical/component SVG filename
162
176
 
@@ -166,7 +180,7 @@ The radical/component SVG filename
166
180
 
167
181
  > `optional` **tags**: `string`[]
168
182
 
169
- Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
183
+ Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L380)
170
184
 
171
185
  Tags generated based on the entry's information
172
186
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Reading
8
8
 
9
- Defined in: [types.ts:394](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L394)
9
+ Defined in: [types.ts:408](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L408)
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:406](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L406)
21
+ Defined in: [types.ts:420](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L420)
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` **notes**: `string`[]
30
30
 
31
- Defined in: [types.ts:402](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L402)
31
+ Defined in: [types.ts:416](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L416)
32
32
 
33
33
  Optional notes for the reading
34
34
 
@@ -38,6 +38,6 @@ Optional notes for the reading
38
38
 
39
39
  > `readonly` **reading**: `string`
40
40
 
41
- Defined in: [types.ts:398](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L398)
41
+ Defined in: [types.ts:412](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L412)
42
42
 
43
43
  The reading (in kana)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ResultEntry\<EntryType\>
8
8
 
9
- Defined in: [types.ts:350](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L350)
9
+ Defined in: [types.ts:360](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L360)
10
10
 
11
11
  Basic Anki note information
12
12
 
@@ -30,17 +30,27 @@ Basic Anki note information
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
33
+ Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L376)
34
34
 
35
35
  The full path of the Anki deck
36
36
 
37
37
  ***
38
38
 
39
+ ### doNotCreateNote?
40
+
41
+ > `optional` **doNotCreateNote**: `true`
42
+
43
+ Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L384)
44
+
45
+ Whether or not this entry should be converted into an Anki note
46
+
47
+ ***
48
+
39
49
  ### id?
40
50
 
41
51
  > `readonly` `optional` **id**: `string`
42
52
 
43
- Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
53
+ Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L368)
44
54
 
45
55
  ID used for the Anki note ID
46
56
 
@@ -50,7 +60,7 @@ ID used for the Anki note ID
50
60
 
51
61
  > `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
52
62
 
53
- Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
63
+ Defined in: [types.ts:364](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L364)
54
64
 
55
65
  ID used for the resulting Anki note
56
66
 
@@ -60,7 +70,7 @@ ID used for the resulting Anki note
60
70
 
61
71
  > `optional` **noteTypeName**: `string`
62
72
 
63
- Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
73
+ Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L372)
64
74
 
65
75
  Anki note type name
66
76
 
@@ -70,6 +80,6 @@ Anki note type name
70
80
 
71
81
  > `optional` **tags**: `string`[]
72
82
 
73
- Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
83
+ Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L380)
74
84
 
75
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:313](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L313)
9
+ Defined in: [types.ts:323](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L323)
10
10
 
11
11
  Tanaka Corpus `examples.utf` examples
12
12
 
@@ -16,7 +16,7 @@ Tanaka Corpus `examples.utf` examples
16
16
 
17
17
  > `optional` **furigana**: `string`
18
18
 
19
- Defined in: [types.ts:329](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L329)
19
+ Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L339)
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
  > **parts**: [`ExamplePart`](ExamplePart.md)[]
28
28
 
29
- Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L325)
29
+ Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L335)
30
30
 
31
31
  The `B` section, split into parts
32
32
 
@@ -36,7 +36,7 @@ The `B` section, split into parts
36
36
 
37
37
  > **phrase**: `string`
38
38
 
39
- Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L317)
39
+ Defined in: [types.ts:327](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L327)
40
40
 
41
41
  The Japanese phrase (found in the `A` section, **before** the tab)
42
42
 
@@ -46,6 +46,6 @@ The Japanese phrase (found in the `A` section, **before** the tab)
46
46
 
47
47
  > **translation**: `string`
48
48
 
49
- Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L321)
49
+ Defined in: [types.ts:331](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L331)
50
50
 
51
51
  The English translation of the phrase (found in the `A` section, **after** the tab)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Translation
8
8
 
9
- Defined in: [types.ts:414](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L414)
9
+ Defined in: [types.ts:428](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L428)
10
10
 
11
11
  A translation of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from [DictMeaning](DictMeaning.md)
18
18
 
19
19
  > `optional` **notes**: `string`[]
20
20
 
21
- Defined in: [types.ts:422](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L422)
21
+ Defined in: [types.ts:436](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L436)
22
22
 
23
23
  Information about the translation
24
24
 
@@ -28,6 +28,6 @@ Information about the translation
28
28
 
29
29
  > `readonly` **translation**: `string`
30
30
 
31
- Defined in: [types.ts:418](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L418)
31
+ Defined in: [types.ts:432](https://github.com/Ronokof/Henkan/blob/cdcdfbcc72ca03339cd98398efd7d5e82826d66f/src/types.ts#L432)
32
32
 
33
33
  The translation