henkan 0.0.2 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +23 -16
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +20 -13
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +10 -0
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.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/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +3 -3
- 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 +3 -3
- package/docs/api/interfaces/DictKanji.md +4 -4
- 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 +5 -5
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/Grammar.md +14 -14
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +10 -10
- package/docs/api/interfaces/Kanji.md +20 -20
- package/docs/api/interfaces/KanjiComponent.md +3 -3
- package/docs/api/interfaces/KanjiForm.md +3 -3
- package/docs/api/interfaces/Phrase.md +4 -4
- package/docs/api/interfaces/Radical.md +24 -14
- package/docs/api/interfaces/Reading.md +4 -4
- package/docs/api/interfaces/ResultEntry.md +6 -6
- package/docs/api/interfaces/TanakaExample.md +5 -5
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +9 -9
- package/docs/api/interfaces/Word.md +24 -12
- 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 +10 -10
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Radical
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:506
|
|
9
|
+
Defined in: [types.ts:506](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L506)
|
|
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
|
|
23
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
|
|
24
24
|
|
|
25
25
|
The full path of the Anki deck
|
|
26
26
|
|
|
@@ -30,11 +30,21 @@ The full path of the Anki deck
|
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
+
### fromJpdb?
|
|
34
|
+
|
|
35
|
+
> `optional` **fromJpdb**: `true`
|
|
36
|
+
|
|
37
|
+
Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L542)
|
|
38
|
+
|
|
39
|
+
Whether or not this radical/component object contains information **only** from `jpdb.io`
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
33
43
|
### id?
|
|
34
44
|
|
|
35
45
|
> `readonly` `optional` **id**: `string`
|
|
36
46
|
|
|
37
|
-
Defined in: types.ts:358
|
|
47
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
|
|
38
48
|
|
|
39
49
|
ID used for the Anki note ID
|
|
40
50
|
|
|
@@ -48,7 +58,7 @@ ID used for the Anki note ID
|
|
|
48
58
|
|
|
49
59
|
> `optional` **kanji**: [`Kanji`](Kanji.md)[]
|
|
50
60
|
|
|
51
|
-
Defined in: types.ts:534
|
|
61
|
+
Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L534)
|
|
52
62
|
|
|
53
63
|
Kanji that include the radical/component
|
|
54
64
|
|
|
@@ -58,7 +68,7 @@ Kanji that include the radical/component
|
|
|
58
68
|
|
|
59
69
|
> **meanings**: `string`[]
|
|
60
70
|
|
|
61
|
-
Defined in: types.ts:518
|
|
71
|
+
Defined in: [types.ts:518](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L518)
|
|
62
72
|
|
|
63
73
|
The radical/component meanings
|
|
64
74
|
|
|
@@ -68,7 +78,7 @@ The radical/component meanings
|
|
|
68
78
|
|
|
69
79
|
> `optional` **mnemonic**: `string`
|
|
70
80
|
|
|
71
|
-
Defined in: types.ts:530
|
|
81
|
+
Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L530)
|
|
72
82
|
|
|
73
83
|
The radical/component mnemonic
|
|
74
84
|
|
|
@@ -78,7 +88,7 @@ The radical/component mnemonic
|
|
|
78
88
|
|
|
79
89
|
> `readonly` `optional` **noteID**: `` `radical_${string}` ``
|
|
80
90
|
|
|
81
|
-
Defined in: types.ts:354
|
|
91
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
|
|
82
92
|
|
|
83
93
|
ID used for the resulting Anki note
|
|
84
94
|
|
|
@@ -92,7 +102,7 @@ ID used for the resulting Anki note
|
|
|
92
102
|
|
|
93
103
|
> `optional` **noteTypeName**: `string`
|
|
94
104
|
|
|
95
|
-
Defined in: types.ts:362
|
|
105
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
|
|
96
106
|
|
|
97
107
|
Anki note type name
|
|
98
108
|
|
|
@@ -106,7 +116,7 @@ Anki note type name
|
|
|
106
116
|
|
|
107
117
|
> `readonly` **radical**: `string`
|
|
108
118
|
|
|
109
|
-
Defined in: types.ts:510
|
|
119
|
+
Defined in: [types.ts:510](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L510)
|
|
110
120
|
|
|
111
121
|
The radical/component character
|
|
112
122
|
|
|
@@ -116,7 +126,7 @@ The radical/component character
|
|
|
116
126
|
|
|
117
127
|
> **reading**: `string`
|
|
118
128
|
|
|
119
|
-
Defined in: types.ts:514
|
|
129
|
+
Defined in: [types.ts:514](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L514)
|
|
120
130
|
|
|
121
131
|
The radical/component reading (in kana)
|
|
122
132
|
|
|
@@ -126,7 +136,7 @@ The radical/component reading (in kana)
|
|
|
126
136
|
|
|
127
137
|
> `optional` **sources**: `string`[]
|
|
128
138
|
|
|
129
|
-
Defined in: types.ts:538
|
|
139
|
+
Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L538)
|
|
130
140
|
|
|
131
141
|
The sources from which data for this radical/component has been extracted
|
|
132
142
|
|
|
@@ -136,7 +146,7 @@ The sources from which data for this radical/component has been extracted
|
|
|
136
146
|
|
|
137
147
|
> `optional` **strokes**: `string`
|
|
138
148
|
|
|
139
|
-
Defined in: types.ts:522
|
|
149
|
+
Defined in: [types.ts:522](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L522)
|
|
140
150
|
|
|
141
151
|
The stroke count of the radical/component
|
|
142
152
|
|
|
@@ -146,7 +156,7 @@ The stroke count of the radical/component
|
|
|
146
156
|
|
|
147
157
|
> `optional` **svg**: `string`
|
|
148
158
|
|
|
149
|
-
Defined in: types.ts:526
|
|
159
|
+
Defined in: [types.ts:526](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L526)
|
|
150
160
|
|
|
151
161
|
The radical/component SVG filename
|
|
152
162
|
|
|
@@ -156,7 +166,7 @@ The radical/component SVG filename
|
|
|
156
166
|
|
|
157
167
|
> `optional` **tags**: `string`[]
|
|
158
168
|
|
|
159
|
-
Defined in: types.ts:370
|
|
169
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
|
|
160
170
|
|
|
161
171
|
Tags generated based on the entry's information
|
|
162
172
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Reading
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:394
|
|
9
|
+
Defined in: [types.ts:394](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L394)
|
|
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
|
|
21
|
+
Defined in: [types.ts:406](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L406)
|
|
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
|
|
31
|
+
Defined in: [types.ts:402](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L402)
|
|
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
|
|
41
|
+
Defined in: [types.ts:398](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L398)
|
|
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
|
|
9
|
+
Defined in: [types.ts:350](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L350)
|
|
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:366
|
|
33
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
|
|
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
|
> `readonly` `optional` **id**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: types.ts:358
|
|
43
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
|
|
44
44
|
|
|
45
45
|
ID used for the Anki note ID
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ ID used for the Anki note ID
|
|
|
50
50
|
|
|
51
51
|
> `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
|
|
52
52
|
|
|
53
|
-
Defined in: types.ts:354
|
|
53
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
|
|
54
54
|
|
|
55
55
|
ID used for the resulting Anki note
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ ID used for the resulting Anki note
|
|
|
60
60
|
|
|
61
61
|
> `optional` **noteTypeName**: `string`
|
|
62
62
|
|
|
63
|
-
Defined in: types.ts:362
|
|
63
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
|
|
64
64
|
|
|
65
65
|
Anki note type name
|
|
66
66
|
|
|
@@ -70,6 +70,6 @@ Anki note type name
|
|
|
70
70
|
|
|
71
71
|
> `optional` **tags**: `string`[]
|
|
72
72
|
|
|
73
|
-
Defined in: types.ts:370
|
|
73
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
|
|
74
74
|
|
|
75
75
|
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
|
|
9
|
+
Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L313)
|
|
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
|
|
19
|
+
Defined in: [types.ts:329](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L329)
|
|
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
|
|
29
|
+
Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L325)
|
|
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
|
|
39
|
+
Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L317)
|
|
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
|
|
49
|
+
Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L321)
|
|
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
|
|
9
|
+
Defined in: [types.ts:414](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L414)
|
|
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
|
|
21
|
+
Defined in: [types.ts:422](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L422)
|
|
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
|
|
31
|
+
Defined in: [types.ts:418](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L418)
|
|
32
32
|
|
|
33
33
|
The translation
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: UsefulRegExps
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:
|
|
9
|
+
Defined in: [types.ts:687](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L687)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:691](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L691)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:699](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L699)
|
|
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:
|
|
39
|
+
Defined in: [types.ts:695](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L695)
|
|
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:
|
|
49
|
+
Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L709)
|
|
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:
|
|
59
|
+
Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L705)
|
|
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:
|
|
71
|
+
Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L713)
|
|
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:
|
|
81
|
+
Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L717)
|
|
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:
|
|
91
|
+
Defined in: [types.ts:721](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L721)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:570](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L570)
|
|
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:
|
|
25
|
+
Defined in: [types.ts:596](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L596)
|
|
26
26
|
|
|
27
27
|
Whether or not the word is common
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ A word is considered *common* if the [DictWord.readings](DictWord.md#readings) a
|
|
|
34
34
|
|
|
35
35
|
> `optional` **deckPath**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: types.ts:366
|
|
37
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
|
|
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
|
> `readonly` `optional` **id**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: types.ts:358
|
|
51
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
|
|
52
52
|
|
|
53
53
|
ID used for the Anki note ID
|
|
54
54
|
|
|
@@ -62,7 +62,7 @@ ID used for the Anki note ID
|
|
|
62
62
|
|
|
63
63
|
> `optional` **kanji**: [`Kanji`](Kanji.md)[]
|
|
64
64
|
|
|
65
|
-
Defined in: types.ts:
|
|
65
|
+
Defined in: [types.ts:586](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L586)
|
|
66
66
|
|
|
67
67
|
A list of kanji used in the kanji forms
|
|
68
68
|
|
|
@@ -72,7 +72,7 @@ A list of kanji used in the kanji forms
|
|
|
72
72
|
|
|
73
73
|
> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
|
|
74
74
|
|
|
75
|
-
Defined in: types.ts:
|
|
75
|
+
Defined in: [types.ts:582](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L582)
|
|
76
76
|
|
|
77
77
|
The word kanji forms
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ The word kanji forms
|
|
|
82
82
|
|
|
83
83
|
> `readonly` `optional` **noteID**: `` `word_${string}` ``
|
|
84
84
|
|
|
85
|
-
Defined in: types.ts:354
|
|
85
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
|
|
86
86
|
|
|
87
87
|
ID used for the resulting Anki note
|
|
88
88
|
|
|
@@ -96,7 +96,7 @@ ID used for the resulting Anki note
|
|
|
96
96
|
|
|
97
97
|
> `optional` **noteTypeName**: `string`
|
|
98
98
|
|
|
99
|
-
Defined in: types.ts:362
|
|
99
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
|
|
100
100
|
|
|
101
101
|
Anki note type name
|
|
102
102
|
|
|
@@ -110,7 +110,7 @@ Anki note type name
|
|
|
110
110
|
|
|
111
111
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
112
112
|
|
|
113
|
-
Defined in: types.ts:
|
|
113
|
+
Defined in: [types.ts:590](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L590)
|
|
114
114
|
|
|
115
115
|
Phrases associated to the word
|
|
116
116
|
|
|
@@ -120,7 +120,7 @@ Phrases associated to the word
|
|
|
120
120
|
|
|
121
121
|
> **readings**: [`Reading`](Reading.md)[]
|
|
122
122
|
|
|
123
|
-
Defined in: types.ts:
|
|
123
|
+
Defined in: [types.ts:574](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L574)
|
|
124
124
|
|
|
125
125
|
The word readings (in kana)
|
|
126
126
|
|
|
@@ -130,7 +130,7 @@ The word readings (in kana)
|
|
|
130
130
|
|
|
131
131
|
> `optional` **tags**: `string`[]
|
|
132
132
|
|
|
133
|
-
Defined in: types.ts:370
|
|
133
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
|
|
134
134
|
|
|
135
135
|
Tags generated based on the entry's information
|
|
136
136
|
|
|
@@ -144,6 +144,18 @@ Tags generated based on the entry's information
|
|
|
144
144
|
|
|
145
145
|
> `optional` **translations**: [`Translation`](Translation.md)[]
|
|
146
146
|
|
|
147
|
-
Defined in: types.ts:
|
|
147
|
+
Defined in: [types.ts:578](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L578)
|
|
148
148
|
|
|
149
149
|
The word translations/senses
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
### usuallyInKana?
|
|
154
|
+
|
|
155
|
+
> `optional` **usuallyInKana**: `true`
|
|
156
|
+
|
|
157
|
+
Defined in: [types.ts:602](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L602)
|
|
158
|
+
|
|
159
|
+
Whether or not the word is typically written in kana alone
|
|
160
|
+
|
|
161
|
+
Set to `true` only if the word is usually written in kana for all word senses.
|
|
@@ -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:335
|
|
11
|
+
Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L335)
|
|
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
|
|
11
|
+
Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/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:345
|
|
11
|
+
Defined in: [types.ts:345](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L345)
|
|
12
12
|
|
|
13
13
|
Names of entry types used for the Anki note IDs
|
|
@@ -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:
|
|
11
|
+
Defined in: [types.ts:682](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L682)
|
|
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.0
|
|
3
|
+
"version": "0.1.0",
|
|
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",
|
|
@@ -56,25 +56,25 @@
|
|
|
56
56
|
"build:esm": "node ./scripts/build-esbuild.cjs esm",
|
|
57
57
|
"build": "npm run clean && npm run build:types && npm run build:esm && npm run build:cjs",
|
|
58
58
|
"lint": "eslint 'src/**/*.{ts,tsx}' --fix",
|
|
59
|
-
"prepare": "npm run lint && npm run build",
|
|
59
|
+
"prepare": "npm run lint && npm run build && npm run docs:api",
|
|
60
60
|
"docs:api": "typedoc --plugin typedoc-plugin-markdown --out docs/api src/index.ts --readme none --excludePrivate --excludeProtected --excludeNotDocumented --hideGenerator"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
|
-
"@types/node": "^24.
|
|
63
|
+
"@types/node": "^24.9.1",
|
|
64
64
|
"@types/xml2js": "^0.4.14",
|
|
65
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
66
|
-
"@typescript-eslint/parser": "^8.
|
|
67
|
-
"esbuild": "^0.25.
|
|
68
|
-
"eslint": "^9.
|
|
65
|
+
"@typescript-eslint/eslint-plugin": "^8.46.2",
|
|
66
|
+
"@typescript-eslint/parser": "^8.46.2",
|
|
67
|
+
"esbuild": "^0.25.11",
|
|
68
|
+
"eslint": "^9.38.0",
|
|
69
69
|
"eslint-plugin-prettier": "^5.5.4",
|
|
70
70
|
"prettier": "^3.6.2",
|
|
71
71
|
"rimraf": "^6.0.1",
|
|
72
|
-
"typedoc": "^0.28.
|
|
72
|
+
"typedoc": "^0.28.14",
|
|
73
73
|
"typedoc-plugin-markdown": "^4.9.0",
|
|
74
|
-
"typescript": "^5.9.
|
|
74
|
+
"typescript": "^5.9.3"
|
|
75
75
|
},
|
|
76
76
|
"dependencies": {
|
|
77
|
-
"@aws-sdk/client-polly": "^3.
|
|
77
|
+
"@aws-sdk/client-polly": "^3.914.0",
|
|
78
78
|
"iconv-lite": "^0.7.0",
|
|
79
79
|
"kuroshiro": "^1.2.0",
|
|
80
80
|
"kuroshiro-analyzer-kuromoji": "^1.1.0",
|