henkan 0.0.3 → 0.1.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 +24 -17
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +21 -14
- 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 +28 -14
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +24 -10
- package/docs/api/interfaces/Kanji.md +34 -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 +29 -15
- package/docs/api/interfaces/Reading.md +4 -4
- package/docs/api/interfaces/ResultEntry.md +16 -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 +38 -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: KanjiForm
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:382](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L382)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:386](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L386)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:390](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L390)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:554](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L554)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:566](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L566)
|
|
22
22
|
|
|
23
23
|
#### See
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **phrase**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:
|
|
33
|
+
Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L558)
|
|
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:
|
|
43
|
+
Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L562)
|
|
44
44
|
|
|
45
45
|
#### See
|
|
46
46
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Radical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:510](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L510)
|
|
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/
|
|
23
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L366)
|
|
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:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
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:
|
|
51
|
+
Defined in: [types.ts:546](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L546)
|
|
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/
|
|
61
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L358)
|
|
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:
|
|
75
|
+
Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L538)
|
|
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:
|
|
85
|
+
Defined in: [types.ts:522](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L522)
|
|
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:
|
|
95
|
+
Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L534)
|
|
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/
|
|
105
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
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/
|
|
119
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
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:
|
|
133
|
+
Defined in: [types.ts:514](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L514)
|
|
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:
|
|
143
|
+
Defined in: [types.ts:518](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L518)
|
|
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:
|
|
153
|
+
Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L542)
|
|
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:
|
|
163
|
+
Defined in: [types.ts:526](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L526)
|
|
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:
|
|
173
|
+
Defined in: [types.ts:530](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L530)
|
|
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/
|
|
183
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:398](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L398)
|
|
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:410](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L410)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:406](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L406)
|
|
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:
|
|
41
|
+
Defined in: [types.ts:402](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L402)
|
|
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/
|
|
9
|
+
Defined in: [types.ts:350](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L350)
|
|
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/
|
|
33
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L366)
|
|
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:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
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/
|
|
53
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L358)
|
|
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/
|
|
63
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
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/
|
|
73
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
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/
|
|
83
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
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/
|
|
9
|
+
Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:329](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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:
|
|
9
|
+
Defined in: [types.ts:418](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L418)
|
|
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:426](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L426)
|
|
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:422](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L422)
|
|
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:691](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L691)
|
|
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:695](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L695)
|
|
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:703](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L703)
|
|
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:699](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L699)
|
|
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:713](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L713)
|
|
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:709](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L709)
|
|
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:717](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L717)
|
|
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:721](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L721)
|
|
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:725](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L725)
|
|
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:574](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L574)
|
|
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:600](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L600)
|
|
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](https://github.com/Ronokof/Henkan/blob/
|
|
37
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L366)
|
|
38
38
|
|
|
39
39
|
The full path of the Anki deck
|
|
40
40
|
|
|
@@ -44,11 +44,25 @@ The full path of the Anki deck
|
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
47
|
+
### doNotCreateNote?
|
|
48
|
+
|
|
49
|
+
> `optional` **doNotCreateNote**: `true`
|
|
50
|
+
|
|
51
|
+
Defined in: [types.ts:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
52
|
+
|
|
53
|
+
Whether or not this entry should be converted into an Anki note
|
|
54
|
+
|
|
55
|
+
#### Inherited from
|
|
56
|
+
|
|
57
|
+
[`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
47
61
|
### id?
|
|
48
62
|
|
|
49
63
|
> `readonly` `optional` **id**: `string`
|
|
50
64
|
|
|
51
|
-
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/
|
|
65
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L358)
|
|
52
66
|
|
|
53
67
|
ID used for the Anki note ID
|
|
54
68
|
|
|
@@ -62,7 +76,7 @@ ID used for the Anki note ID
|
|
|
62
76
|
|
|
63
77
|
> `optional` **kanji**: [`Kanji`](Kanji.md)[]
|
|
64
78
|
|
|
65
|
-
Defined in: [types.ts:
|
|
79
|
+
Defined in: [types.ts:590](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L590)
|
|
66
80
|
|
|
67
81
|
A list of kanji used in the kanji forms
|
|
68
82
|
|
|
@@ -72,7 +86,7 @@ A list of kanji used in the kanji forms
|
|
|
72
86
|
|
|
73
87
|
> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
|
|
74
88
|
|
|
75
|
-
Defined in: [types.ts:
|
|
89
|
+
Defined in: [types.ts:586](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L586)
|
|
76
90
|
|
|
77
91
|
The word kanji forms
|
|
78
92
|
|
|
@@ -82,7 +96,7 @@ The word kanji forms
|
|
|
82
96
|
|
|
83
97
|
> `readonly` `optional` **noteID**: `` `word_${string}` ``
|
|
84
98
|
|
|
85
|
-
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/
|
|
99
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
86
100
|
|
|
87
101
|
ID used for the resulting Anki note
|
|
88
102
|
|
|
@@ -96,7 +110,7 @@ ID used for the resulting Anki note
|
|
|
96
110
|
|
|
97
111
|
> `optional` **noteTypeName**: `string`
|
|
98
112
|
|
|
99
|
-
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/
|
|
113
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
100
114
|
|
|
101
115
|
Anki note type name
|
|
102
116
|
|
|
@@ -110,7 +124,7 @@ Anki note type name
|
|
|
110
124
|
|
|
111
125
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
112
126
|
|
|
113
|
-
Defined in: [types.ts:
|
|
127
|
+
Defined in: [types.ts:594](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L594)
|
|
114
128
|
|
|
115
129
|
Phrases associated to the word
|
|
116
130
|
|
|
@@ -120,7 +134,7 @@ Phrases associated to the word
|
|
|
120
134
|
|
|
121
135
|
> **readings**: [`Reading`](Reading.md)[]
|
|
122
136
|
|
|
123
|
-
Defined in: [types.ts:
|
|
137
|
+
Defined in: [types.ts:578](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L578)
|
|
124
138
|
|
|
125
139
|
The word readings (in kana)
|
|
126
140
|
|
|
@@ -130,7 +144,7 @@ The word readings (in kana)
|
|
|
130
144
|
|
|
131
145
|
> `optional` **tags**: `string`[]
|
|
132
146
|
|
|
133
|
-
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/
|
|
147
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
134
148
|
|
|
135
149
|
Tags generated based on the entry's information
|
|
136
150
|
|
|
@@ -144,6 +158,18 @@ Tags generated based on the entry's information
|
|
|
144
158
|
|
|
145
159
|
> `optional` **translations**: [`Translation`](Translation.md)[]
|
|
146
160
|
|
|
147
|
-
Defined in: [types.ts:
|
|
161
|
+
Defined in: [types.ts:582](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L582)
|
|
148
162
|
|
|
149
163
|
The word translations/senses
|
|
164
|
+
|
|
165
|
+
***
|
|
166
|
+
|
|
167
|
+
### usuallyInKana?
|
|
168
|
+
|
|
169
|
+
> `optional` **usuallyInKana**: `true`
|
|
170
|
+
|
|
171
|
+
Defined in: [types.ts:606](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L606)
|
|
172
|
+
|
|
173
|
+
Whether or not the word is typically written in kana alone
|
|
174
|
+
|
|
175
|
+
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](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [types.ts:345](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/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
|
> **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/52fe6d98746996eb6471b21af2a4100c9ce484cf/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:
|
|
11
|
+
Defined in: [types.ts:686](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L686)
|
|
12
12
|
|
|
13
13
|
Any type of converted entry from a [Dict](Dict.md) array + others not from a dictionary
|