henkan 0.4.0 → 0.4.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 +108 -79
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +108 -79
- package/dist/index.mjs.map +2 -2
- package/dist/types/utils.d.ts +2 -2
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +3 -3
- 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/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +1 -1
- package/docs/api/functions/getKanji.md +1 -1
- package/docs/api/functions/getKanjiExtended.md +1 -1
- package/docs/api/functions/getWord.md +1 -1
- package/docs/api/functions/isStringArray.md +1 -1
- package/docs/api/functions/isValidArray.md +1 -1
- package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
- package/docs/api/functions/makeSSML.md +1 -1
- package/docs/api/functions/shuffleArray.md +1 -1
- package/docs/api/functions/synthesizeSpeech.md +1 -1
- package/docs/api/interfaces/DictKanji.md +5 -5
- package/docs/api/interfaces/DictKanjiForm.md +4 -4
- package/docs/api/interfaces/DictKanjiMisc.md +5 -5
- package/docs/api/interfaces/DictKanjiReading.md +3 -3
- package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
- package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
- package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
- package/docs/api/interfaces/DictMeaning.md +11 -11
- package/docs/api/interfaces/DictRadical.md +4 -4
- package/docs/api/interfaces/DictReading.md +5 -5
- package/docs/api/interfaces/DictWord.md +8 -8
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/Grammar.md +15 -15
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +22 -22
- 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/Phrase.md +4 -4
- 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/TanakaExample.md +6 -6
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +9 -9
- package/docs/api/interfaces/Word.md +14 -14
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/DictName.md +1 -1
- package/docs/api/type-aliases/EntryType.md +1 -1
- package/docs/api/type-aliases/JLPT.md +1 -1
- package/docs/api/type-aliases/Result.md +1 -1
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NoteAndTag
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:402](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:402](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L402)
|
|
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:406](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:406](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L406)
|
|
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:410](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:410](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L410)
|
|
30
30
|
|
|
31
31
|
The tag
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Phrase
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:602](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:602](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L602)
|
|
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:614](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:614](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L614)
|
|
22
22
|
|
|
23
23
|
#### See
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Defined in: [types.ts:614](https://github.com/Ronokof/Henkan/blob/874e0ce148c569
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **phrase**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:606](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:606](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L606)
|
|
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:610](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:610](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L610)
|
|
44
44
|
|
|
45
45
|
#### See
|
|
46
46
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Radical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L558)
|
|
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:388](https://github.com/Ronokof/Henkan/blob/
|
|
23
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L388)
|
|
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:396](https://github.com/Ronokof/Henkan/blob/
|
|
37
|
+
Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L396)
|
|
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:594](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:594](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L594)
|
|
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:380](https://github.com/Ronokof/Henkan/blob/
|
|
61
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L380)
|
|
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:586](https://github.com/Ronokof/Henkan/blob/
|
|
75
|
+
Defined in: [types.ts:586](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L586)
|
|
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:570](https://github.com/Ronokof/Henkan/blob/
|
|
85
|
+
Defined in: [types.ts:570](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L570)
|
|
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:582](https://github.com/Ronokof/Henkan/blob/
|
|
95
|
+
Defined in: [types.ts:582](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L582)
|
|
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:376](https://github.com/Ronokof/Henkan/blob/
|
|
105
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L376)
|
|
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:384](https://github.com/Ronokof/Henkan/blob/
|
|
119
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L384)
|
|
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:562](https://github.com/Ronokof/Henkan/blob/
|
|
133
|
+
Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L562)
|
|
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:566](https://github.com/Ronokof/Henkan/blob/
|
|
143
|
+
Defined in: [types.ts:566](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L566)
|
|
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:590](https://github.com/Ronokof/Henkan/blob/
|
|
153
|
+
Defined in: [types.ts:590](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L590)
|
|
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:574](https://github.com/Ronokof/Henkan/blob/
|
|
163
|
+
Defined in: [types.ts:574](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L574)
|
|
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:578](https://github.com/Ronokof/Henkan/blob/
|
|
173
|
+
Defined in: [types.ts:578](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L578)
|
|
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:392](https://github.com/Ronokof/Henkan/blob/
|
|
183
|
+
Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L392)
|
|
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:438](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:438](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L438)
|
|
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:454](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:454](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L454)
|
|
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:450](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L450)
|
|
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:446](https://github.com/Ronokof/Henkan/blob/
|
|
41
|
+
Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L446)
|
|
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:442](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L442)
|
|
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:372](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L372)
|
|
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:388](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L388)
|
|
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:396](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L396)
|
|
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:380](https://github.com/Ronokof/Henkan/blob/
|
|
53
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L380)
|
|
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:376](https://github.com/Ronokof/Henkan/blob/
|
|
63
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L376)
|
|
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:384](https://github.com/Ronokof/Henkan/blob/
|
|
73
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L384)
|
|
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:392](https://github.com/Ronokof/Henkan/blob/
|
|
83
|
+
Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L392)
|
|
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:331](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:331](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L331)
|
|
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:351](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:351](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L351)
|
|
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
|
> `readonly` **id**: `` `${number}_${number}` ``
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L335)
|
|
30
30
|
|
|
31
31
|
The ID of the example
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The ID of the example
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **parts**: [`ExamplePart`](ExamplePart.md)[]
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L347)
|
|
40
40
|
|
|
41
41
|
The `B` section, split into parts
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The `B` section, split into parts
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **phrase**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L339)
|
|
50
50
|
|
|
51
51
|
The Japanese phrase (found in the `A` section, **before** the tab)
|
|
52
52
|
|
|
@@ -56,6 +56,6 @@ The Japanese phrase (found in the `A` section, **before** the tab)
|
|
|
56
56
|
|
|
57
57
|
> `readonly` **translation**: `string`
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L343)
|
|
60
60
|
|
|
61
61
|
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:462](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:462](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L462)
|
|
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:470](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:470](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L470)
|
|
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:466](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:466](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L466)
|
|
32
32
|
|
|
33
33
|
The translation
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: UsefulRegExps
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:735](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:735](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L735)
|
|
10
10
|
|
|
11
11
|
Some useful regular expressions
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Some useful regular expressions
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **hiragana**: `RegExp`
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:739](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:739](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L739)
|
|
20
20
|
|
|
21
21
|
Matches any *hiragana* character(s)
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Matches any *hiragana* character(s)
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **kanji**: `RegExp`
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:747](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:747](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L747)
|
|
30
30
|
|
|
31
31
|
Matches any *kanji* character(s)
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Matches any *kanji* character(s)
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **katakana**: `RegExp`
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:743](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:743](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L743)
|
|
40
40
|
|
|
41
41
|
Matches any *katakana* character(s)
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ Matches any *katakana* character(s)
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **regExChars**: `RegExp`
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L757)
|
|
50
50
|
|
|
51
51
|
Matches any character that is part of the regex syntax
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ Matches any character that is part of the regex syntax
|
|
|
56
56
|
|
|
57
57
|
> `readonly` **scriptSplit**: `RegExp`
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L753)
|
|
60
60
|
|
|
61
61
|
Matches and splits Japanese expressions into different scripts
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Used when creating a SSML
|
|
|
68
68
|
|
|
69
69
|
> `readonly` **tanakaID**: `RegExp`
|
|
70
70
|
|
|
71
|
-
Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/
|
|
71
|
+
Defined in: [types.ts:761](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L761)
|
|
72
72
|
|
|
73
73
|
Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
|
|
|
78
78
|
|
|
79
79
|
> `readonly` **tanakaPart**: `RegExp`
|
|
80
80
|
|
|
81
|
-
Defined in: [types.ts:765](https://github.com/Ronokof/Henkan/blob/
|
|
81
|
+
Defined in: [types.ts:765](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L765)
|
|
82
82
|
|
|
83
83
|
Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.utf` file
|
|
84
84
|
|
|
@@ -88,6 +88,6 @@ Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.
|
|
|
88
88
|
|
|
89
89
|
> `readonly` **tanakaReferenceID**: `RegExp`
|
|
90
90
|
|
|
91
|
-
Defined in: [types.ts:769](https://github.com/Ronokof/Henkan/blob/
|
|
91
|
+
Defined in: [types.ts:769](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L769)
|
|
92
92
|
|
|
93
93
|
Matches the reference ID element of a Tanaka example part
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Word
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:622](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:622](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L622)
|
|
10
10
|
|
|
11
11
|
Word information
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Converted from [DictWord](DictWord.md)
|
|
|
22
22
|
|
|
23
23
|
> `optional` **common**: `true`
|
|
24
24
|
|
|
25
|
-
Defined in: [types.ts:646](https://github.com/Ronokof/Henkan/blob/
|
|
25
|
+
Defined in: [types.ts:646](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L646)
|
|
26
26
|
|
|
27
27
|
#### See
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [types.ts:646](https://github.com/Ronokof/Henkan/blob/874e0ce148c569
|
|
|
34
34
|
|
|
35
35
|
> `optional` **deckPath**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/
|
|
37
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L388)
|
|
38
38
|
|
|
39
39
|
The full path of the Anki deck
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ The full path of the Anki deck
|
|
|
48
48
|
|
|
49
49
|
> `optional` **doNotCreateNote**: `true`
|
|
50
50
|
|
|
51
|
-
Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L396)
|
|
52
52
|
|
|
53
53
|
Whether or not this entry should be converted into an Anki note
|
|
54
54
|
|
|
@@ -62,7 +62,7 @@ Whether or not this entry should be converted into an Anki note
|
|
|
62
62
|
|
|
63
63
|
> `readonly` `optional` **id**: `string`
|
|
64
64
|
|
|
65
|
-
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/
|
|
65
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L380)
|
|
66
66
|
|
|
67
67
|
ID used for the Anki note ID
|
|
68
68
|
|
|
@@ -76,7 +76,7 @@ ID used for the Anki note ID
|
|
|
76
76
|
|
|
77
77
|
> `optional` **kanji**: [`Kanji`](Kanji.md)[]
|
|
78
78
|
|
|
79
|
-
Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/
|
|
79
|
+
Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L638)
|
|
80
80
|
|
|
81
81
|
A list of kanji used in the kanji forms
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ A list of kanji used in the kanji forms
|
|
|
86
86
|
|
|
87
87
|
> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
|
|
88
88
|
|
|
89
|
-
Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/
|
|
89
|
+
Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L634)
|
|
90
90
|
|
|
91
91
|
The word kanji forms
|
|
92
92
|
|
|
@@ -96,7 +96,7 @@ The word kanji forms
|
|
|
96
96
|
|
|
97
97
|
> `readonly` `optional` **noteID**: `` `word_${string}` ``
|
|
98
98
|
|
|
99
|
-
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/
|
|
99
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L376)
|
|
100
100
|
|
|
101
101
|
ID used for the resulting Anki note
|
|
102
102
|
|
|
@@ -110,7 +110,7 @@ ID used for the resulting Anki note
|
|
|
110
110
|
|
|
111
111
|
> `optional` **noteTypeName**: `string`
|
|
112
112
|
|
|
113
|
-
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/
|
|
113
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L384)
|
|
114
114
|
|
|
115
115
|
Anki note type name
|
|
116
116
|
|
|
@@ -124,7 +124,7 @@ Anki note type name
|
|
|
124
124
|
|
|
125
125
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
126
126
|
|
|
127
|
-
Defined in: [types.ts:642](https://github.com/Ronokof/Henkan/blob/
|
|
127
|
+
Defined in: [types.ts:642](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L642)
|
|
128
128
|
|
|
129
129
|
Phrases associated to the word
|
|
130
130
|
|
|
@@ -134,7 +134,7 @@ Phrases associated to the word
|
|
|
134
134
|
|
|
135
135
|
> **readings**: [`Reading`](Reading.md)[]
|
|
136
136
|
|
|
137
|
-
Defined in: [types.ts:626](https://github.com/Ronokof/Henkan/blob/
|
|
137
|
+
Defined in: [types.ts:626](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L626)
|
|
138
138
|
|
|
139
139
|
The word readings (in kana)
|
|
140
140
|
|
|
@@ -144,7 +144,7 @@ The word readings (in kana)
|
|
|
144
144
|
|
|
145
145
|
> `optional` **tags**: `string`[]
|
|
146
146
|
|
|
147
|
-
Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/
|
|
147
|
+
Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L392)
|
|
148
148
|
|
|
149
149
|
Tags generated based on the entry's information
|
|
150
150
|
|
|
@@ -158,7 +158,7 @@ Tags generated based on the entry's information
|
|
|
158
158
|
|
|
159
159
|
> `optional` **translations**: [`Translation`](Translation.md)[]
|
|
160
160
|
|
|
161
|
-
Defined in: [types.ts:630](https://github.com/Ronokof/Henkan/blob/
|
|
161
|
+
Defined in: [types.ts:630](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L630)
|
|
162
162
|
|
|
163
163
|
The word translations/senses
|
|
164
164
|
|
|
@@ -168,7 +168,7 @@ The word translations/senses
|
|
|
168
168
|
|
|
169
169
|
> `optional` **usuallyInKana**: `true`
|
|
170
170
|
|
|
171
|
-
Defined in: [types.ts:650](https://github.com/Ronokof/Henkan/blob/
|
|
171
|
+
Defined in: [types.ts:650](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L650)
|
|
172
172
|
|
|
173
173
|
#### See
|
|
174
174
|
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **Dict** = [`DictWord`](../interfaces/DictWord.md)[] \| [`DictKanji`](../interfaces/DictKanji.md)[] \| [`TanakaExample`](../interfaces/TanakaExample.md)[] \| [`DictRadical`](../interfaces/DictRadical.md)[] \| [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L357)
|
|
12
12
|
|
|
13
13
|
Any type of entry list
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **DictName** = `"JMDict"` \| `"Kanjidic"` \| `"tanaka"` \| `"radk"` \| `"krad"`
|
|
10
10
|
|
|
11
|
-
Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L9)
|
|
12
12
|
|
|
13
13
|
Standardized dictionary names
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **EntryType** = `"word"` \| `"kanji"` \| `"radical"` \| `"kana"` \| `"grammar"`
|
|
10
10
|
|
|
11
|
-
Defined in: [types.ts:367](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:367](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L367)
|
|
12
12
|
|
|
13
13
|
Names of entry types used for the Anki note IDs
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **JLPT** = `"N5"` \| `"N4"` \| `"N3"` \| `"N2"` \| `"N1"`
|
|
10
10
|
|
|
11
|
-
Defined in: [types.ts:4](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:4](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L4)
|
|
12
12
|
|
|
13
13
|
JLPT levels
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **Result** = [`Word`](../interfaces/Word.md) \| [`Kanji`](../interfaces/Kanji.md) \| [`Radical`](../interfaces/Radical.md) \| [`Kana`](../interfaces/Kana.md) \| [`Grammar`](../interfaces/Grammar.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [types.ts:730](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:730](https://github.com/Ronokof/Henkan/blob/9d6f8c36a5a74a8db04f8876da97affa6d0cbb77/src/types.ts#L730)
|
|
12
12
|
|
|
13
13
|
Any type of converted entry from a [Dict](Dict.md) array + others not from a dictionary
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "henkan",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "A Node.JS library that helps you convert any dictionary from EDRDG, transform their entries into more user-friendly schemas and create Anki notes from them.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"fjsd",
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
"typescript": "^5.9.3"
|
|
75
75
|
},
|
|
76
76
|
"dependencies": {
|
|
77
|
-
"@aws-sdk/client-polly": "^3.
|
|
77
|
+
"@aws-sdk/client-polly": "^3.932.0",
|
|
78
78
|
"iconv-lite": "^0.7.0",
|
|
79
79
|
"kuroshiro": "^1.2.0",
|
|
80
80
|
"kuroshiro-analyzer-kuromoji": "^1.1.0",
|