henkan 2.1.0 → 2.2.1
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.
- package/dist/index.cjs.js +224 -98
- package/dist/index.cjs.js.map +3 -3
- package/dist/index.mjs +223 -98
- package/dist/index.mjs.map +3 -3
- package/dist/types/types.d.ts +53 -0
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +37 -18
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/README.md +8 -0
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +1 -1
- package/docs/api/functions/convertJawiktionaryAsync.md +1 -1
- package/docs/api/functions/convertJawiktionarySync.md +1 -1
- package/docs/api/functions/convertKanjiDic.md +1 -1
- package/docs/api/functions/convertKradFile.md +1 -1
- package/docs/api/functions/convertRadkFile.md +1 -1
- package/docs/api/functions/convertTanakaCorpus.md +1 -1
- package/docs/api/functions/convertTanakaCorpusWithFurigana.md +1 -1
- package/docs/api/functions/createEntryMaps.md +59 -0
- package/docs/api/functions/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +1 -1
- package/docs/api/functions/getKanji.md +9 -9
- package/docs/api/functions/getKanjiExtended.md +7 -7
- package/docs/api/functions/getValidForms.md +1 -1
- package/docs/api/functions/getWord.md +11 -11
- package/docs/api/functions/getWordDefinitions.md +1 -1
- package/docs/api/functions/getWordDefinitionsWithFurigana.md +1 -1
- package/docs/api/functions/isObjectArray.md +1 -1
- package/docs/api/functions/isStringArray.md +1 -1
- package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
- package/docs/api/functions/shuffleArray.md +1 -1
- package/docs/api/interfaces/DefaultNoteInfo.md +4 -4
- package/docs/api/interfaces/Definition.md +4 -4
- package/docs/api/interfaces/EntryMaps.md +83 -0
- package/docs/api/interfaces/Grammar.md +15 -15
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/JaWiktionaryEntry.md +5 -5
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +23 -23
- package/docs/api/interfaces/KanjiComponent.md +3 -3
- package/docs/api/interfaces/KanjiForm.md +4 -4
- package/docs/api/interfaces/NoteAndTag.md +3 -3
- package/docs/api/interfaces/NoteHeaderKeys.md +7 -7
- package/docs/api/interfaces/Phrase.md +5 -5
- package/docs/api/interfaces/Radical.md +16 -16
- package/docs/api/interfaces/Reading.md +5 -5
- package/docs/api/interfaces/ResultEntry.md +7 -7
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +8 -8
- package/docs/api/interfaces/Word.md +15 -15
- package/docs/api/interfaces/WordDefinitionPair.md +3 -3
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/EntryType.md +1 -1
- package/docs/api/type-aliases/KanjiEntryMap.md +13 -0
- package/docs/api/type-aliases/KanjiSVGMap.md +13 -0
- package/docs/api/type-aliases/KanjiWordsMap.md +13 -0
- package/docs/api/type-aliases/Result.md +1 -1
- package/docs/api/type-aliases/WordDefinitionsMap.md +13 -0
- package/docs/api/type-aliases/WordExamplesMap.md +13 -0
- package/docs/api/type-aliases/WordIDEntryMap.md +13 -0
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Kanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:694](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
82
82
|
|
|
83
83
|
> `optional` **grade**: `string`
|
|
84
84
|
|
|
85
|
-
Defined in: [types.ts:
|
|
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:690](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
94
94
|
|
|
95
95
|
> `optional` **id**: `` `${number}` ``
|
|
96
96
|
|
|
97
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:698](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
120
120
|
|
|
121
121
|
> `readonly` **kanji**: `string`
|
|
122
122
|
|
|
123
|
-
Defined in: [types.ts:
|
|
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,7 +132,7 @@ Defined in: [types.ts:650](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
132
132
|
|
|
133
133
|
> `optional` **kokuji**: `true`
|
|
134
134
|
|
|
135
|
-
Defined in: [types.ts:
|
|
135
|
+
Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L757)
|
|
136
136
|
|
|
137
137
|
Whether or not the kanji is a kokuji
|
|
138
138
|
|
|
@@ -142,7 +142,7 @@ Whether or not the kanji is a kokuji
|
|
|
142
142
|
|
|
143
143
|
> `optional` **kunyomi**: `string`[]
|
|
144
144
|
|
|
145
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:658](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
164
164
|
|
|
165
165
|
> `optional` **mnemonic**: `string`
|
|
166
166
|
|
|
167
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:670](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
186
186
|
|
|
187
187
|
> `optional` **noteID**: `string`
|
|
188
188
|
|
|
189
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:654](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
246
246
|
|
|
247
247
|
> `optional` **svg**: `string`
|
|
248
248
|
|
|
249
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KanjiComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KanjiForm
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NoteAndTag
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
29
|
+
Defined in: [types.ts:619](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L619)
|
|
30
30
|
|
|
31
31
|
The tag
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NoteHeaderKeys
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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 `:`*)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Phrase
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:776](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **originalPhrase**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:
|
|
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:772](https://github.com/Ronokof/Henkan/blob/main/src/types
|
|
|
42
42
|
|
|
43
43
|
> `readonly` **phrase**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [types.ts:
|
|
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:
|
|
55
|
+
Defined in: [types.ts:823](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L823)
|
|
56
56
|
|
|
57
57
|
#### See
|
|
58
58
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Radical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Reading
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:647](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L647)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:663](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L663)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:659](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L659)
|
|
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:
|
|
41
|
+
Defined in: [types.ts:655](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L655)
|
|
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:
|
|
51
|
+
Defined in: [types.ts:651](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L651)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:581](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L581)
|
|
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:
|
|
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
|
|
|
@@ -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:
|
|
43
|
+
Defined in: [types.ts:605](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L605)
|
|
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
|
> `optional` **id**: `` `${number}` ``
|
|
52
52
|
|
|
53
|
-
Defined in: [types.ts:
|
|
53
|
+
Defined in: [types.ts:589](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L589)
|
|
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
|
> `optional` **noteID**: `string`
|
|
62
62
|
|
|
63
|
-
Defined in: [types.ts:
|
|
63
|
+
Defined in: [types.ts:585](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L585)
|
|
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:
|
|
73
|
+
Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
|
|
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:
|
|
83
|
+
Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
|
|
84
84
|
|
|
85
85
|
Tags generated based on the entry's information
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Translation
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:671](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L671)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:679](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L679)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:675](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L675)
|
|
32
32
|
|
|
33
33
|
The translation
|