henkan 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +2 -2
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +2 -2
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +1 -1
- package/docs/api/functions/convertJawiktionary.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 +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/getWordDefinitions.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/shuffleArray.md +1 -1
- package/docs/api/functions/synthesizeSpeech.md +1 -1
- package/docs/api/interfaces/Definition.md +4 -4
- 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/GlossSpecificNumber.md +3 -3
- 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 +5 -5
- package/docs/api/interfaces/Radical.md +16 -16
- package/docs/api/interfaces/Reading.md +5 -5
- package/docs/api/interfaces/ResultEntry.md +7 -7
- package/docs/api/interfaces/TanakaExample.md +7 -7
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +8 -8
- package/docs/api/interfaces/Word.md +15 -15
- package/docs/api/interfaces/WordDefinitionPair.md +3 -3
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/DictName.md +1 -1
- package/docs/api/type-aliases/DictTranslation.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 +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KanjiForm
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:477](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:477](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L477)
|
|
10
10
|
|
|
11
11
|
A kanji form of the word
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Converted from a [DictKanjiForm](DictKanjiForm.md)
|
|
|
18
18
|
|
|
19
19
|
> `optional` **common**: `true`
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:489](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:489](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L489)
|
|
22
22
|
|
|
23
23
|
Whether or not the kanji form is common
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ Whether or not the kanji form is common
|
|
|
28
28
|
|
|
29
29
|
> `readonly` **kanjiForm**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [types.ts:481](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:481](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L481)
|
|
32
32
|
|
|
33
33
|
The kanji form
|
|
34
34
|
|
|
@@ -38,6 +38,6 @@ The kanji form
|
|
|
38
38
|
|
|
39
39
|
> `optional` **notes**: `string`[]
|
|
40
40
|
|
|
41
|
-
Defined in: [types.ts:485](https://github.com/Ronokof/Henkan/blob/
|
|
41
|
+
Defined in: [types.ts:485](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L485)
|
|
42
42
|
|
|
43
43
|
Optional notes for the kanji form
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NoteAndTag
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:461](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:461](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L461)
|
|
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:465](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:465](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L465)
|
|
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:469](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:469](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L469)
|
|
30
30
|
|
|
31
31
|
The tag
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Phrase
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:661](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L661)
|
|
10
10
|
|
|
11
11
|
Phrase information
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
|
|
|
18
18
|
|
|
19
19
|
> `readonly` `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L677)
|
|
22
22
|
|
|
23
23
|
#### See
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Defined in: [types.ts:677](https://github.com/Ronokof/Henkan/blob/e0f685c675998b
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **originalPhrase**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L673)
|
|
34
34
|
|
|
35
35
|
#### See
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ Defined in: [types.ts:673](https://github.com/Ronokof/Henkan/blob/e0f685c675998b
|
|
|
42
42
|
|
|
43
43
|
> `readonly` **phrase**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/
|
|
45
|
+
Defined in: [types.ts:665](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L665)
|
|
46
46
|
|
|
47
47
|
The Japanese phrase, either with furigana attached or not
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ The Japanese phrase, either with furigana attached or not
|
|
|
52
52
|
|
|
53
53
|
> `readonly` **translation**: `string`
|
|
54
54
|
|
|
55
|
-
Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/
|
|
55
|
+
Defined in: [types.ts:669](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L669)
|
|
56
56
|
|
|
57
57
|
#### See
|
|
58
58
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Radical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:617](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:617](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L617)
|
|
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:447](https://github.com/Ronokof/Henkan/blob/
|
|
23
|
+
Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
|
|
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:455](https://github.com/Ronokof/Henkan/blob/
|
|
37
|
+
Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
|
|
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:653](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:653](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L653)
|
|
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:439](https://github.com/Ronokof/Henkan/blob/
|
|
61
|
+
Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
|
|
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:645](https://github.com/Ronokof/Henkan/blob/
|
|
75
|
+
Defined in: [types.ts:645](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L645)
|
|
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:629](https://github.com/Ronokof/Henkan/blob/
|
|
85
|
+
Defined in: [types.ts:629](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L629)
|
|
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:641](https://github.com/Ronokof/Henkan/blob/
|
|
95
|
+
Defined in: [types.ts:641](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L641)
|
|
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:435](https://github.com/Ronokof/Henkan/blob/
|
|
105
|
+
Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
|
|
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:443](https://github.com/Ronokof/Henkan/blob/
|
|
119
|
+
Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
|
|
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:621](https://github.com/Ronokof/Henkan/blob/
|
|
133
|
+
Defined in: [types.ts:621](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L621)
|
|
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:625](https://github.com/Ronokof/Henkan/blob/
|
|
143
|
+
Defined in: [types.ts:625](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L625)
|
|
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:649](https://github.com/Ronokof/Henkan/blob/
|
|
153
|
+
Defined in: [types.ts:649](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L649)
|
|
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:633](https://github.com/Ronokof/Henkan/blob/
|
|
163
|
+
Defined in: [types.ts:633](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L633)
|
|
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:637](https://github.com/Ronokof/Henkan/blob/
|
|
173
|
+
Defined in: [types.ts:637](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L637)
|
|
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:451](https://github.com/Ronokof/Henkan/blob/
|
|
183
|
+
Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
|
|
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:497](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:497](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L497)
|
|
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:513](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:513](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L513)
|
|
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:509](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:509](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L509)
|
|
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:505](https://github.com/Ronokof/Henkan/blob/
|
|
41
|
+
Defined in: [types.ts:505](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L505)
|
|
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:501](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:501](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L501)
|
|
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:431](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:431](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L431)
|
|
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:447](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
|
|
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:455](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
|
|
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:439](https://github.com/Ronokof/Henkan/blob/
|
|
53
|
+
Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
|
|
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:435](https://github.com/Ronokof/Henkan/blob/
|
|
63
|
+
Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
|
|
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:443](https://github.com/Ronokof/Henkan/blob/
|
|
73
|
+
Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
|
|
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:451](https://github.com/Ronokof/Henkan/blob/
|
|
83
|
+
Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
|
|
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:353](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L353)
|
|
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:373](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:373](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L373)
|
|
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
|
> `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L377)
|
|
30
30
|
|
|
31
31
|
The word-gloss pair
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The word-gloss pair
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **id**: `` `${number}_${number}` ``
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L357)
|
|
40
40
|
|
|
41
41
|
The ID of the example
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The ID of the example
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **parts**: [`ExamplePart`](ExamplePart.md)[]
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L369)
|
|
50
50
|
|
|
51
51
|
The `B` section, split into parts
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ The `B` section, split into parts
|
|
|
56
56
|
|
|
57
57
|
> `readonly` **phrase**: `string`
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L361)
|
|
60
60
|
|
|
61
61
|
The Japanese phrase (found in the `A` section, **before** the tab)
|
|
62
62
|
|
|
@@ -66,6 +66,6 @@ The Japanese phrase (found in the `A` section, **before** the tab)
|
|
|
66
66
|
|
|
67
67
|
> `readonly` **translation**: `string`
|
|
68
68
|
|
|
69
|
-
Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/
|
|
69
|
+
Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L365)
|
|
70
70
|
|
|
71
71
|
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:521](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:521](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L521)
|
|
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:529](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:529](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L529)
|
|
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:525](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:525](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L525)
|
|
32
32
|
|
|
33
33
|
The translation
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: UsefulRegExps
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:802](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:802](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L802)
|
|
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:806](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:806](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L806)
|
|
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:814](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:814](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L814)
|
|
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:810](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:810](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L810)
|
|
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:818](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:818](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L818)
|
|
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` **tanakaID**: `RegExp`
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:822](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:822](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L822)
|
|
60
60
|
|
|
61
61
|
Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
|
|
|
66
66
|
|
|
67
67
|
> `readonly` **tanakaPart**: `RegExp`
|
|
68
68
|
|
|
69
|
-
Defined in: [types.ts:826](https://github.com/Ronokof/Henkan/blob/
|
|
69
|
+
Defined in: [types.ts:826](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L826)
|
|
70
70
|
|
|
71
71
|
Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.utf` file
|
|
72
72
|
|
|
@@ -76,6 +76,6 @@ Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.
|
|
|
76
76
|
|
|
77
77
|
> `readonly` **tanakaReferenceID**: `RegExp`
|
|
78
78
|
|
|
79
|
-
Defined in: [types.ts:830](https://github.com/Ronokof/Henkan/blob/
|
|
79
|
+
Defined in: [types.ts:830](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L830)
|
|
80
80
|
|
|
81
81
|
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:685](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:685](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L685)
|
|
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:713](https://github.com/Ronokof/Henkan/blob/
|
|
25
|
+
Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L713)
|
|
26
26
|
|
|
27
27
|
#### See
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/e0f685c675998b
|
|
|
34
34
|
|
|
35
35
|
> `optional` **deckPath**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/
|
|
37
|
+
Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
|
|
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` **definitions**: [`Definition`](Definition.md)[]
|
|
50
50
|
|
|
51
|
-
Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L709)
|
|
52
52
|
|
|
53
53
|
Japanese definitions associated with the word
|
|
54
54
|
|
|
@@ -58,7 +58,7 @@ Japanese definitions associated with the word
|
|
|
58
58
|
|
|
59
59
|
> `optional` **doNotCreateNote**: `true`
|
|
60
60
|
|
|
61
|
-
Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/
|
|
61
|
+
Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
|
|
62
62
|
|
|
63
63
|
Whether or not this entry should be converted into an Anki note
|
|
64
64
|
|
|
@@ -72,7 +72,7 @@ Whether or not this entry should be converted into an Anki note
|
|
|
72
72
|
|
|
73
73
|
> `readonly` `optional` **id**: `string`
|
|
74
74
|
|
|
75
|
-
Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/
|
|
75
|
+
Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
|
|
76
76
|
|
|
77
77
|
ID used for the Anki note ID
|
|
78
78
|
|
|
@@ -86,7 +86,7 @@ ID used for the Anki note ID
|
|
|
86
86
|
|
|
87
87
|
> `optional` **kanji**: [`Kanji`](Kanji.md)[]
|
|
88
88
|
|
|
89
|
-
Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/
|
|
89
|
+
Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L701)
|
|
90
90
|
|
|
91
91
|
A list of kanji used in the kanji forms
|
|
92
92
|
|
|
@@ -96,7 +96,7 @@ A list of kanji used in the kanji forms
|
|
|
96
96
|
|
|
97
97
|
> `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
|
|
98
98
|
|
|
99
|
-
Defined in: [types.ts:697](https://github.com/Ronokof/Henkan/blob/
|
|
99
|
+
Defined in: [types.ts:697](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L697)
|
|
100
100
|
|
|
101
101
|
The word kanji forms
|
|
102
102
|
|
|
@@ -106,7 +106,7 @@ The word kanji forms
|
|
|
106
106
|
|
|
107
107
|
> `readonly` `optional` **noteID**: `` `word_${string}` ``
|
|
108
108
|
|
|
109
|
-
Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/
|
|
109
|
+
Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
|
|
110
110
|
|
|
111
111
|
ID used for the resulting Anki note
|
|
112
112
|
|
|
@@ -120,7 +120,7 @@ ID used for the resulting Anki note
|
|
|
120
120
|
|
|
121
121
|
> `optional` **noteTypeName**: `string`
|
|
122
122
|
|
|
123
|
-
Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/
|
|
123
|
+
Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
|
|
124
124
|
|
|
125
125
|
Anki note type name
|
|
126
126
|
|
|
@@ -134,7 +134,7 @@ Anki note type name
|
|
|
134
134
|
|
|
135
135
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
136
136
|
|
|
137
|
-
Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/
|
|
137
|
+
Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L705)
|
|
138
138
|
|
|
139
139
|
Phrases associated to the word
|
|
140
140
|
|
|
@@ -144,7 +144,7 @@ Phrases associated to the word
|
|
|
144
144
|
|
|
145
145
|
> **readings**: [`Reading`](Reading.md)[]
|
|
146
146
|
|
|
147
|
-
Defined in: [types.ts:689](https://github.com/Ronokof/Henkan/blob/
|
|
147
|
+
Defined in: [types.ts:689](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L689)
|
|
148
148
|
|
|
149
149
|
The word readings (in kana)
|
|
150
150
|
|
|
@@ -154,7 +154,7 @@ The word readings (in kana)
|
|
|
154
154
|
|
|
155
155
|
> `optional` **tags**: `string`[]
|
|
156
156
|
|
|
157
|
-
Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/
|
|
157
|
+
Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
|
|
158
158
|
|
|
159
159
|
Tags generated based on the entry's information
|
|
160
160
|
|
|
@@ -168,7 +168,7 @@ Tags generated based on the entry's information
|
|
|
168
168
|
|
|
169
169
|
> **translations**: [`Translation`](Translation.md)[]
|
|
170
170
|
|
|
171
|
-
Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/
|
|
171
|
+
Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L693)
|
|
172
172
|
|
|
173
173
|
The word translations/senses
|
|
174
174
|
|
|
@@ -178,7 +178,7 @@ The word translations/senses
|
|
|
178
178
|
|
|
179
179
|
> `optional` **usuallyInKana**: `true`
|
|
180
180
|
|
|
181
|
-
Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/
|
|
181
|
+
Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L717)
|
|
182
182
|
|
|
183
183
|
#### See
|
|
184
184
|
|