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: DictReading
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L40)
|
|
10
10
|
|
|
11
11
|
Word reading information
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Equivalent to the `r_ele` JMdict element
|
|
|
18
18
|
|
|
19
19
|
> `optional` **commonness**: `string`[]
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L56)
|
|
22
22
|
|
|
23
23
|
Priority codes
|
|
24
24
|
|
|
@@ -32,7 +32,7 @@ Priority codes
|
|
|
32
32
|
|
|
33
33
|
> `optional` **kanjiFormRestrictions**: `string`[]
|
|
34
34
|
|
|
35
|
-
Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/
|
|
35
|
+
Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L60)
|
|
36
36
|
|
|
37
37
|
Kanji forms the reading is restricted to
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ Kanji forms the reading is restricted to
|
|
|
42
42
|
|
|
43
43
|
> `optional` **notes**: `string`[]
|
|
44
44
|
|
|
45
|
-
Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/
|
|
45
|
+
Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L50)
|
|
46
46
|
|
|
47
47
|
Other information about the reading
|
|
48
48
|
|
|
@@ -56,6 +56,6 @@ Other information about the reading
|
|
|
56
56
|
|
|
57
57
|
> `readonly` **reading**: `string`
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L44)
|
|
60
60
|
|
|
61
61
|
The reading of the word
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictWord
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:125](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:125](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L125)
|
|
10
10
|
|
|
11
11
|
JMdict entry (word)
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Equivalent to the `entry` JMdict element
|
|
|
18
18
|
|
|
19
19
|
> `readonly` **id**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:129](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:129](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L129)
|
|
22
22
|
|
|
23
23
|
The entry sequence number
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ The entry sequence number
|
|
|
28
28
|
|
|
29
29
|
> `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
|
|
30
30
|
|
|
31
|
-
Defined in: [types.ts:133](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:133](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L133)
|
|
32
32
|
|
|
33
33
|
The word's kanji forms
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ The word's kanji forms
|
|
|
38
38
|
|
|
39
39
|
> **meanings**: [`DictMeaning`](DictMeaning.md)[]
|
|
40
40
|
|
|
41
|
-
Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/
|
|
41
|
+
Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L141)
|
|
42
42
|
|
|
43
43
|
The word's meanings/senses
|
|
44
44
|
|
|
@@ -48,6 +48,6 @@ The word's meanings/senses
|
|
|
48
48
|
|
|
49
49
|
> **readings**: [`DictReading`](DictReading.md)[]
|
|
50
50
|
|
|
51
|
-
Defined in: [types.ts:137](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:137](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L137)
|
|
52
52
|
|
|
53
53
|
The word's readings
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ExamplePart
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L279)
|
|
10
10
|
|
|
11
11
|
A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
|
|
|
16
16
|
|
|
17
17
|
> **baseForm**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L283)
|
|
20
20
|
|
|
21
21
|
The common form in which the word is found in JMdict
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The common form in which the word is found in JMdict
|
|
|
26
26
|
|
|
27
27
|
> `optional` **edited**: `true`
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:307](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:307](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L307)
|
|
30
30
|
|
|
31
31
|
Whether or not the word is part of an entry that has been edited and adapted
|
|
32
32
|
|
|
@@ -40,7 +40,7 @@ Whether or not the word is part of an entry that has been edited and adapted
|
|
|
40
40
|
|
|
41
41
|
> `optional` **glossNumber**: `number`
|
|
42
42
|
|
|
43
|
-
Defined in: [types.ts:291](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:291](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L291)
|
|
44
44
|
|
|
45
45
|
The JMdict sense number corresponding to the word’s usage in the phrase
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ The JMdict sense number corresponding to the word’s usage in the phrase
|
|
|
50
50
|
|
|
51
51
|
> `optional` **inflectedForm**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [types.ts:295](https://github.com/Ronokof/Henkan/blob/
|
|
53
|
+
Defined in: [types.ts:295](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L295)
|
|
54
54
|
|
|
55
55
|
The actual form in which the word is used in the phrase
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ The actual form in which the word is used in the phrase
|
|
|
60
60
|
|
|
61
61
|
> `optional` **reading**: `string`
|
|
62
62
|
|
|
63
|
-
Defined in: [types.ts:287](https://github.com/Ronokof/Henkan/blob/
|
|
63
|
+
Defined in: [types.ts:287](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L287)
|
|
64
64
|
|
|
65
65
|
The reading (in kana) of the word
|
|
66
66
|
|
|
@@ -70,6 +70,6 @@ The reading (in kana) of the word
|
|
|
70
70
|
|
|
71
71
|
> `optional` **referenceID**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/
|
|
73
|
+
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L299)
|
|
74
74
|
|
|
75
75
|
A sequence number that references a JMdict entry associated with the word
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Grammar
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:648](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L648)
|
|
10
10
|
|
|
11
11
|
Grammar point information
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Grammar point information
|
|
|
20
20
|
|
|
21
21
|
> `optional` **audio**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [types.ts:
|
|
23
|
+
Defined in: [types.ts:680](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L680)
|
|
24
24
|
|
|
25
25
|
The filename of an audio file for the grammar point
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The filename of an audio file for the grammar point
|
|
|
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
|
|
|
@@ -40,11 +40,25 @@ The full path of the Anki deck
|
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
43
|
+
### doNotCreateNote?
|
|
44
|
+
|
|
45
|
+
> `optional` **doNotCreateNote**: `true`
|
|
46
|
+
|
|
47
|
+
Defined in: [types.ts:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
48
|
+
|
|
49
|
+
Whether or not this entry should be converted into an Anki note
|
|
50
|
+
|
|
51
|
+
#### Inherited from
|
|
52
|
+
|
|
53
|
+
[`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
43
57
|
### id?
|
|
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` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
|
|
60
74
|
|
|
61
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:672](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L672)
|
|
62
76
|
|
|
63
77
|
The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Test\_format) level
|
|
64
78
|
|
|
@@ -68,7 +82,7 @@ The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficie
|
|
|
68
82
|
|
|
69
83
|
> **meaning**: [`GrammarMeaning`](GrammarMeaning.md)
|
|
70
84
|
|
|
71
|
-
Defined in: [types.ts:
|
|
85
|
+
Defined in: [types.ts:656](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L656)
|
|
72
86
|
|
|
73
87
|
The English meaning/translation of the grammar point
|
|
74
88
|
|
|
@@ -78,7 +92,7 @@ The English meaning/translation of the grammar point
|
|
|
78
92
|
|
|
79
93
|
> `readonly` `optional` **noteID**: `` `grammar_${string}` ``
|
|
80
94
|
|
|
81
|
-
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/
|
|
95
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
82
96
|
|
|
83
97
|
ID used for the resulting Anki note
|
|
84
98
|
|
|
@@ -92,7 +106,7 @@ ID used for the resulting Anki note
|
|
|
92
106
|
|
|
93
107
|
> `optional` **noteTypeName**: `string`
|
|
94
108
|
|
|
95
|
-
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/
|
|
109
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
96
110
|
|
|
97
111
|
Anki note type name
|
|
98
112
|
|
|
@@ -106,7 +120,7 @@ Anki note type name
|
|
|
106
120
|
|
|
107
121
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
108
122
|
|
|
109
|
-
Defined in: [types.ts:
|
|
123
|
+
Defined in: [types.ts:668](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L668)
|
|
110
124
|
|
|
111
125
|
Example phrase using the grammar point
|
|
112
126
|
|
|
@@ -116,7 +130,7 @@ Example phrase using the grammar point
|
|
|
116
130
|
|
|
117
131
|
> `readonly` **point**: `string`
|
|
118
132
|
|
|
119
|
-
Defined in: [types.ts:
|
|
133
|
+
Defined in: [types.ts:652](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L652)
|
|
120
134
|
|
|
121
135
|
The most common form in which the grammar point written in
|
|
122
136
|
|
|
@@ -126,7 +140,7 @@ The most common form in which the grammar point written in
|
|
|
126
140
|
|
|
127
141
|
> `optional` **readings**: [`Reading`](Reading.md)[]
|
|
128
142
|
|
|
129
|
-
Defined in: [types.ts:
|
|
143
|
+
Defined in: [types.ts:660](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L660)
|
|
130
144
|
|
|
131
145
|
The readings of the grammar point
|
|
132
146
|
|
|
@@ -136,7 +150,7 @@ The readings of the grammar point
|
|
|
136
150
|
|
|
137
151
|
> `optional` **source**: `string`
|
|
138
152
|
|
|
139
|
-
Defined in: [types.ts:
|
|
153
|
+
Defined in: [types.ts:676](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L676)
|
|
140
154
|
|
|
141
155
|
The source from which data for this grammar point has been extracted
|
|
142
156
|
|
|
@@ -146,7 +160,7 @@ The source from which data for this grammar point has been extracted
|
|
|
146
160
|
|
|
147
161
|
> `optional` **tags**: `string`[]
|
|
148
162
|
|
|
149
|
-
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/
|
|
163
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
150
164
|
|
|
151
165
|
Tags generated based on the entry's information
|
|
152
166
|
|
|
@@ -160,6 +174,6 @@ Tags generated based on the entry's information
|
|
|
160
174
|
|
|
161
175
|
> `optional` **usages**: `string`[]
|
|
162
176
|
|
|
163
|
-
Defined in: [types.ts:
|
|
177
|
+
Defined in: [types.ts:664](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L664)
|
|
164
178
|
|
|
165
179
|
Ways in which the grammar point is used in Japanese
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: GrammarMeaning
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L634)
|
|
10
10
|
|
|
11
11
|
Grammar point meaning
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Grammar point meaning
|
|
|
16
16
|
|
|
17
17
|
> `optional` **example**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:
|
|
19
|
+
Defined in: [types.ts:642](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L642)
|
|
20
20
|
|
|
21
21
|
An example phrase using the grammar point
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ An example phrase using the grammar point
|
|
|
26
26
|
|
|
27
27
|
> **meaning**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:
|
|
29
|
+
Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L638)
|
|
30
30
|
|
|
31
31
|
The meaning of the grammar point
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Kana
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:612](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L612)
|
|
10
10
|
|
|
11
11
|
Kana information
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Kana information
|
|
|
20
20
|
|
|
21
21
|
> `optional` **audio**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [types.ts:
|
|
23
|
+
Defined in: [types.ts:624](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L624)
|
|
24
24
|
|
|
25
25
|
The filename of an audio file for the kana reading
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The filename of an audio file for the kana reading
|
|
|
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
|
|
|
@@ -40,11 +40,25 @@ The full path of the Anki deck
|
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
43
|
+
### doNotCreateNote?
|
|
44
|
+
|
|
45
|
+
> `optional` **doNotCreateNote**: `true`
|
|
46
|
+
|
|
47
|
+
Defined in: [types.ts:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
48
|
+
|
|
49
|
+
Whether or not this entry should be converted into an Anki note
|
|
50
|
+
|
|
51
|
+
#### Inherited from
|
|
52
|
+
|
|
53
|
+
[`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
43
57
|
### id?
|
|
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
|
> `readonly` **kana**: `string`
|
|
60
74
|
|
|
61
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:616](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L616)
|
|
62
76
|
|
|
63
77
|
The kana character
|
|
64
78
|
|
|
@@ -68,7 +82,7 @@ The kana character
|
|
|
68
82
|
|
|
69
83
|
> `readonly` `optional` **noteID**: `` `kana_${string}` ``
|
|
70
84
|
|
|
71
|
-
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/
|
|
85
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
72
86
|
|
|
73
87
|
ID used for the resulting Anki note
|
|
74
88
|
|
|
@@ -82,7 +96,7 @@ ID used for the resulting Anki note
|
|
|
82
96
|
|
|
83
97
|
> `optional` **noteTypeName**: `string`
|
|
84
98
|
|
|
85
|
-
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/
|
|
99
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
86
100
|
|
|
87
101
|
Anki note type name
|
|
88
102
|
|
|
@@ -96,7 +110,7 @@ Anki note type name
|
|
|
96
110
|
|
|
97
111
|
> **reading**: `string`
|
|
98
112
|
|
|
99
|
-
Defined in: [types.ts:
|
|
113
|
+
Defined in: [types.ts:620](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L620)
|
|
100
114
|
|
|
101
115
|
The romaji reading of the kana
|
|
102
116
|
|
|
@@ -106,7 +120,7 @@ The romaji reading of the kana
|
|
|
106
120
|
|
|
107
121
|
> `optional` **svg**: `string`
|
|
108
122
|
|
|
109
|
-
Defined in: [types.ts:
|
|
123
|
+
Defined in: [types.ts:628](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L628)
|
|
110
124
|
|
|
111
125
|
The kana SVG filename
|
|
112
126
|
|
|
@@ -116,7 +130,7 @@ The kana SVG filename
|
|
|
116
130
|
|
|
117
131
|
> `optional` **tags**: `string`[]
|
|
118
132
|
|
|
119
|
-
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/
|
|
133
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
120
134
|
|
|
121
135
|
Tags generated based on the entry's information
|
|
122
136
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Kanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:448](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L448)
|
|
10
10
|
|
|
11
11
|
Kanji information
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Converted from [DictKanji](DictKanji.md) and extra info added
|
|
|
22
22
|
|
|
23
23
|
> `optional` **components**: [`KanjiComponent`](KanjiComponent.md)[]
|
|
24
24
|
|
|
25
|
-
Defined in: [types.ts:
|
|
25
|
+
Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L480)
|
|
26
26
|
|
|
27
27
|
The kanji radicals/components
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ The kanji radicals/components
|
|
|
32
32
|
|
|
33
33
|
> `optional` **deckPath**: `string`
|
|
34
34
|
|
|
35
|
-
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/
|
|
35
|
+
Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L366)
|
|
36
36
|
|
|
37
37
|
The full path of the Anki deck
|
|
38
38
|
|
|
@@ -42,11 +42,25 @@ The full path of the Anki deck
|
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
|
+
### doNotCreateNote?
|
|
46
|
+
|
|
47
|
+
> `optional` **doNotCreateNote**: `true`
|
|
48
|
+
|
|
49
|
+
Defined in: [types.ts:374](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L374)
|
|
50
|
+
|
|
51
|
+
Whether or not this entry should be converted into an Anki note
|
|
52
|
+
|
|
53
|
+
#### Inherited from
|
|
54
|
+
|
|
55
|
+
[`ResultEntry`](ResultEntry.md).[`doNotCreateNote`](ResultEntry.md#donotcreatenote)
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
45
59
|
### frequency?
|
|
46
60
|
|
|
47
61
|
> `optional` **frequency**: `string`
|
|
48
62
|
|
|
49
|
-
Defined in: [types.ts:
|
|
63
|
+
Defined in: [types.ts:496](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L496)
|
|
50
64
|
|
|
51
65
|
#### See
|
|
52
66
|
|
|
@@ -58,7 +72,7 @@ Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
58
72
|
|
|
59
73
|
> `optional` **fromJpdb**: `true`
|
|
60
74
|
|
|
61
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:504](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L504)
|
|
62
76
|
|
|
63
77
|
Whether or not this kanji object contains information **only** from `jpdb.io`
|
|
64
78
|
|
|
@@ -68,7 +82,7 @@ Whether or not this kanji object contains information **only** from `jpdb.io`
|
|
|
68
82
|
|
|
69
83
|
> `optional` **grade**: `string`
|
|
70
84
|
|
|
71
|
-
Defined in: [types.ts:
|
|
85
|
+
Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L492)
|
|
72
86
|
|
|
73
87
|
#### See
|
|
74
88
|
|
|
@@ -80,7 +94,7 @@ Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
80
94
|
|
|
81
95
|
> `readonly` `optional` **id**: `string`
|
|
82
96
|
|
|
83
|
-
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/
|
|
97
|
+
Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L358)
|
|
84
98
|
|
|
85
99
|
ID used for the Anki note ID
|
|
86
100
|
|
|
@@ -94,7 +108,7 @@ ID used for the Anki note ID
|
|
|
94
108
|
|
|
95
109
|
> `readonly` **kanji**: `string`
|
|
96
110
|
|
|
97
|
-
Defined in: [types.ts:
|
|
111
|
+
Defined in: [types.ts:452](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L452)
|
|
98
112
|
|
|
99
113
|
#### See
|
|
100
114
|
|
|
@@ -106,7 +120,7 @@ Defined in: [types.ts:448](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
106
120
|
|
|
107
121
|
> `optional` **kunyomi**: `string`[]
|
|
108
122
|
|
|
109
|
-
Defined in: [types.ts:
|
|
123
|
+
Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L468)
|
|
110
124
|
|
|
111
125
|
The kanji kunyomi readings
|
|
112
126
|
|
|
@@ -116,7 +130,7 @@ The kanji kunyomi readings
|
|
|
116
130
|
|
|
117
131
|
> `optional` **meanings**: `string`[]
|
|
118
132
|
|
|
119
|
-
Defined in: [types.ts:
|
|
133
|
+
Defined in: [types.ts:460](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L460)
|
|
120
134
|
|
|
121
135
|
#### See
|
|
122
136
|
|
|
@@ -128,7 +142,7 @@ Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
128
142
|
|
|
129
143
|
> `optional` **mnemonic**: `string`
|
|
130
144
|
|
|
131
|
-
Defined in: [types.ts:
|
|
145
|
+
Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L484)
|
|
132
146
|
|
|
133
147
|
The kanji mnemonic
|
|
134
148
|
|
|
@@ -138,7 +152,7 @@ The kanji mnemonic
|
|
|
138
152
|
|
|
139
153
|
> `optional` **nanori**: `string`[]
|
|
140
154
|
|
|
141
|
-
Defined in: [types.ts:
|
|
155
|
+
Defined in: [types.ts:472](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L472)
|
|
142
156
|
|
|
143
157
|
#### See
|
|
144
158
|
|
|
@@ -150,7 +164,7 @@ Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
150
164
|
|
|
151
165
|
> `readonly` `optional` **noteID**: `` `kanji_${string}` ``
|
|
152
166
|
|
|
153
|
-
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/
|
|
167
|
+
Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L354)
|
|
154
168
|
|
|
155
169
|
ID used for the resulting Anki note
|
|
156
170
|
|
|
@@ -164,7 +178,7 @@ ID used for the resulting Anki note
|
|
|
164
178
|
|
|
165
179
|
> `optional` **noteTypeName**: `string`
|
|
166
180
|
|
|
167
|
-
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/
|
|
181
|
+
Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L362)
|
|
168
182
|
|
|
169
183
|
Anki note type name
|
|
170
184
|
|
|
@@ -178,7 +192,7 @@ Anki note type name
|
|
|
178
192
|
|
|
179
193
|
> `optional` **onyomi**: `string`[]
|
|
180
194
|
|
|
181
|
-
Defined in: [types.ts:
|
|
195
|
+
Defined in: [types.ts:464](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L464)
|
|
182
196
|
|
|
183
197
|
The kanji onyomi readings
|
|
184
198
|
|
|
@@ -188,7 +202,7 @@ The kanji onyomi readings
|
|
|
188
202
|
|
|
189
203
|
> `optional` **source**: `string`
|
|
190
204
|
|
|
191
|
-
Defined in: [types.ts:
|
|
205
|
+
Defined in: [types.ts:500](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L500)
|
|
192
206
|
|
|
193
207
|
The source (besides KANJIDIC) from which data for this kanji has been extracted
|
|
194
208
|
|
|
@@ -198,7 +212,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
|
|
|
198
212
|
|
|
199
213
|
> `optional` **strokes**: `string`
|
|
200
214
|
|
|
201
|
-
Defined in: [types.ts:
|
|
215
|
+
Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L456)
|
|
202
216
|
|
|
203
217
|
#### See
|
|
204
218
|
|
|
@@ -210,7 +224,7 @@ Defined in: [types.ts:452](https://github.com/Ronokof/Henkan/blob/98f666aefeafaf
|
|
|
210
224
|
|
|
211
225
|
> `optional` **svg**: `string`
|
|
212
226
|
|
|
213
|
-
Defined in: [types.ts:
|
|
227
|
+
Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L476)
|
|
214
228
|
|
|
215
229
|
The kanji SVG filename
|
|
216
230
|
|
|
@@ -220,7 +234,7 @@ The kanji SVG filename
|
|
|
220
234
|
|
|
221
235
|
> `optional` **tags**: `string`[]
|
|
222
236
|
|
|
223
|
-
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/
|
|
237
|
+
Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L370)
|
|
224
238
|
|
|
225
239
|
Tags generated based on the entry's information
|
|
226
240
|
|
|
@@ -234,6 +248,6 @@ Tags generated based on the entry's information
|
|
|
234
248
|
|
|
235
249
|
> `optional` **words**: [`Word`](Word.md)[]
|
|
236
250
|
|
|
237
|
-
Defined in: [types.ts:
|
|
251
|
+
Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L488)
|
|
238
252
|
|
|
239
253
|
Words that use the kanji
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: KanjiComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:432](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L432)
|
|
10
10
|
|
|
11
11
|
Kanji component information
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Kanji component information
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **component**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:
|
|
19
|
+
Defined in: [types.ts:436](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L436)
|
|
20
20
|
|
|
21
21
|
The component character
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ The component character
|
|
|
26
26
|
|
|
27
27
|
> `optional` **meaning**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:
|
|
29
|
+
Defined in: [types.ts:440](https://github.com/Ronokof/Henkan/blob/52fe6d98746996eb6471b21af2a4100c9ce484cf/src/types.ts#L440)
|
|
30
30
|
|
|
31
31
|
The meaning of the component
|