henkan 0.1.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +87 -57
- package/dist/index.cjs.js.map +3 -3
- package/dist/index.mjs +85 -57
- package/dist/index.mjs.map +3 -3
- package/dist/types/types.d.ts +24 -3
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/README.md +1 -0
- 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 +1 -1
- package/docs/api/functions/getKanji.md +1 -1
- package/docs/api/functions/getKanjiExtended.md +1 -1
- package/docs/api/functions/getWord.md +1 -1
- package/docs/api/functions/isStringArray.md +1 -1
- package/docs/api/functions/isValidArray.md +1 -1
- package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
- package/docs/api/functions/makeSSML.md +1 -1
- package/docs/api/functions/shuffleArray.md +1 -1
- package/docs/api/functions/synthesizeSpeech.md +1 -1
- package/docs/api/interfaces/DictKanji.md +14 -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 +8 -8
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/Grammar.md +15 -15
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +31 -21
- package/docs/api/interfaces/KanjiComponent.md +3 -3
- package/docs/api/interfaces/KanjiForm.md +3 -3
- package/docs/api/interfaces/NoteAndTag.md +31 -0
- package/docs/api/interfaces/Phrase.md +4 -4
- package/docs/api/interfaces/Radical.md +16 -16
- package/docs/api/interfaces/Reading.md +4 -4
- 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 +9 -9
- package/docs/api/interfaces/Word.md +14 -14
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/DictName.md +1 -1
- package/docs/api/type-aliases/EntryType.md +1 -1
- package/docs/api/type-aliases/JLPT.md +1 -1
- package/docs/api/type-aliases/Result.md +1 -1
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictRadical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:259](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L259)
|
|
10
10
|
|
|
11
11
|
RADKFILE2 entry (radical)
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ RADKFILE2 entry (radical)
|
|
|
16
16
|
|
|
17
17
|
> **kanji**: [`DictKanji`](DictKanji.md)[]
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:
|
|
19
|
+
Defined in: [types.ts:267](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L267)
|
|
20
20
|
|
|
21
21
|
The kanji that include the radical
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The kanji that include the radical
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **radical**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [types.ts:
|
|
29
|
+
Defined in: [types.ts:263](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L263)
|
|
30
30
|
|
|
31
31
|
The radical character
|
|
32
32
|
|
|
@@ -36,6 +36,6 @@ The radical character
|
|
|
36
36
|
|
|
37
37
|
> **strokes**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:
|
|
39
|
+
Defined in: [types.ts:271](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L271)
|
|
40
40
|
|
|
41
41
|
The stroke count of the radical
|
|
@@ -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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/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/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L125)
|
|
10
10
|
|
|
11
11
|
JMdict entry (word)
|
|
12
12
|
|
|
@@ -18,11 +18,11 @@ Equivalent to the `entry` JMdict element
|
|
|
18
18
|
|
|
19
19
|
> `optional` **hasPhrases**: `true`
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L151)
|
|
22
22
|
|
|
23
23
|
Whether or not the entry has at least one Tanaka Corpus phrase associated with it
|
|
24
24
|
|
|
25
|
-
**May not always be accurate**
|
|
25
|
+
**May not always be accurate** (It may only be `true` incorrectly. If it is `undefined`, the report is 100% correct.)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Whether or not the entry has at least one Tanaka Corpus phrase associated with i
|
|
|
30
30
|
|
|
31
31
|
> `readonly` **id**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:129](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:129](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L129)
|
|
34
34
|
|
|
35
35
|
The entry sequence number
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The entry sequence number
|
|
|
40
40
|
|
|
41
41
|
> `optional` **isCommon**: `true`
|
|
42
42
|
|
|
43
|
-
Defined in: [types.ts:145](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:145](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L145)
|
|
44
44
|
|
|
45
45
|
Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
|
|
|
50
50
|
|
|
51
51
|
> `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
|
|
52
52
|
|
|
53
|
-
Defined in: [types.ts:133](https://github.com/Ronokof/Henkan/blob/
|
|
53
|
+
Defined in: [types.ts:133](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L133)
|
|
54
54
|
|
|
55
55
|
The word's kanji forms
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ The word's kanji forms
|
|
|
60
60
|
|
|
61
61
|
> **meanings**: [`DictMeaning`](DictMeaning.md)[]
|
|
62
62
|
|
|
63
|
-
Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/
|
|
63
|
+
Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L141)
|
|
64
64
|
|
|
65
65
|
The word's meanings/senses
|
|
66
66
|
|
|
@@ -70,6 +70,6 @@ The word's meanings/senses
|
|
|
70
70
|
|
|
71
71
|
> **readings**: [`DictReading`](DictReading.md)[]
|
|
72
72
|
|
|
73
|
-
Defined in: [types.ts:137](https://github.com/Ronokof/Henkan/blob/
|
|
73
|
+
Defined in: [types.ts:137](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L137)
|
|
74
74
|
|
|
75
75
|
The word's readings
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ExamplePart
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L293)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:297](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L297)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L321)
|
|
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:
|
|
43
|
+
Defined in: [types.ts:305](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L305)
|
|
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:
|
|
53
|
+
Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L309)
|
|
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:
|
|
63
|
+
Defined in: [types.ts:301](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L301)
|
|
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:
|
|
73
|
+
Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L313)
|
|
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:680](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L680)
|
|
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:712](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L712)
|
|
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:
|
|
33
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L380)
|
|
34
34
|
|
|
35
35
|
The full path of the Anki deck
|
|
36
36
|
|
|
@@ -44,7 +44,7 @@ The full path of the Anki deck
|
|
|
44
44
|
|
|
45
45
|
> `optional` **doNotCreateNote**: `true`
|
|
46
46
|
|
|
47
|
-
Defined in: [types.ts:
|
|
47
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L388)
|
|
48
48
|
|
|
49
49
|
Whether or not this entry should be converted into an Anki note
|
|
50
50
|
|
|
@@ -58,7 +58,7 @@ Whether or not this entry should be converted into an Anki note
|
|
|
58
58
|
|
|
59
59
|
> `readonly` `optional` **id**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [types.ts:
|
|
61
|
+
Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L372)
|
|
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` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
|
|
74
74
|
|
|
75
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:704](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L704)
|
|
76
76
|
|
|
77
77
|
The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Test\_format) level
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficie
|
|
|
82
82
|
|
|
83
83
|
> **meaning**: [`GrammarMeaning`](GrammarMeaning.md)
|
|
84
84
|
|
|
85
|
-
Defined in: [types.ts:
|
|
85
|
+
Defined in: [types.ts:688](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L688)
|
|
86
86
|
|
|
87
87
|
The English meaning/translation of the grammar point
|
|
88
88
|
|
|
@@ -92,7 +92,7 @@ The English meaning/translation of the grammar point
|
|
|
92
92
|
|
|
93
93
|
> `readonly` `optional` **noteID**: `` `grammar_${string}` ``
|
|
94
94
|
|
|
95
|
-
Defined in: [types.ts:
|
|
95
|
+
Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L368)
|
|
96
96
|
|
|
97
97
|
ID used for the resulting Anki note
|
|
98
98
|
|
|
@@ -106,7 +106,7 @@ ID used for the resulting Anki note
|
|
|
106
106
|
|
|
107
107
|
> `optional` **noteTypeName**: `string`
|
|
108
108
|
|
|
109
|
-
Defined in: [types.ts:
|
|
109
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L376)
|
|
110
110
|
|
|
111
111
|
Anki note type name
|
|
112
112
|
|
|
@@ -120,7 +120,7 @@ Anki note type name
|
|
|
120
120
|
|
|
121
121
|
> `optional` **phrases**: [`Phrase`](Phrase.md)[]
|
|
122
122
|
|
|
123
|
-
Defined in: [types.ts:
|
|
123
|
+
Defined in: [types.ts:700](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L700)
|
|
124
124
|
|
|
125
125
|
Example phrase using the grammar point
|
|
126
126
|
|
|
@@ -130,7 +130,7 @@ Example phrase using the grammar point
|
|
|
130
130
|
|
|
131
131
|
> `readonly` **point**: `string`
|
|
132
132
|
|
|
133
|
-
Defined in: [types.ts:
|
|
133
|
+
Defined in: [types.ts:684](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L684)
|
|
134
134
|
|
|
135
135
|
The most common form in which the grammar point written in
|
|
136
136
|
|
|
@@ -140,7 +140,7 @@ The most common form in which the grammar point written in
|
|
|
140
140
|
|
|
141
141
|
> `optional` **readings**: [`Reading`](Reading.md)[]
|
|
142
142
|
|
|
143
|
-
Defined in: [types.ts:
|
|
143
|
+
Defined in: [types.ts:692](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L692)
|
|
144
144
|
|
|
145
145
|
The readings of the grammar point
|
|
146
146
|
|
|
@@ -150,7 +150,7 @@ The readings of the grammar point
|
|
|
150
150
|
|
|
151
151
|
> `optional` **source**: `string`
|
|
152
152
|
|
|
153
|
-
Defined in: [types.ts:
|
|
153
|
+
Defined in: [types.ts:708](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L708)
|
|
154
154
|
|
|
155
155
|
The source from which data for this grammar point has been extracted
|
|
156
156
|
|
|
@@ -160,7 +160,7 @@ The source from which data for this grammar point has been extracted
|
|
|
160
160
|
|
|
161
161
|
> `optional` **tags**: `string`[]
|
|
162
162
|
|
|
163
|
-
Defined in: [types.ts:
|
|
163
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L384)
|
|
164
164
|
|
|
165
165
|
Tags generated based on the entry's information
|
|
166
166
|
|
|
@@ -174,6 +174,6 @@ Tags generated based on the entry's information
|
|
|
174
174
|
|
|
175
175
|
> `optional` **usages**: `string`[]
|
|
176
176
|
|
|
177
|
-
Defined in: [types.ts:
|
|
177
|
+
Defined in: [types.ts:696](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L696)
|
|
178
178
|
|
|
179
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:666](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L666)
|
|
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:674](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L674)
|
|
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:670](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L670)
|
|
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:644](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L644)
|
|
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:656](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L656)
|
|
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:
|
|
33
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L380)
|
|
34
34
|
|
|
35
35
|
The full path of the Anki deck
|
|
36
36
|
|
|
@@ -44,7 +44,7 @@ The full path of the Anki deck
|
|
|
44
44
|
|
|
45
45
|
> `optional` **doNotCreateNote**: `true`
|
|
46
46
|
|
|
47
|
-
Defined in: [types.ts:
|
|
47
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L388)
|
|
48
48
|
|
|
49
49
|
Whether or not this entry should be converted into an Anki note
|
|
50
50
|
|
|
@@ -58,7 +58,7 @@ Whether or not this entry should be converted into an Anki note
|
|
|
58
58
|
|
|
59
59
|
> `readonly` `optional` **id**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [types.ts:
|
|
61
|
+
Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L372)
|
|
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
|
> `readonly` **kana**: `string`
|
|
74
74
|
|
|
75
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:648](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L648)
|
|
76
76
|
|
|
77
77
|
The kana character
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ The kana character
|
|
|
82
82
|
|
|
83
83
|
> `readonly` `optional` **noteID**: `` `kana_${string}` ``
|
|
84
84
|
|
|
85
|
-
Defined in: [types.ts:
|
|
85
|
+
Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L368)
|
|
86
86
|
|
|
87
87
|
ID used for the resulting Anki note
|
|
88
88
|
|
|
@@ -96,7 +96,7 @@ ID used for the resulting Anki note
|
|
|
96
96
|
|
|
97
97
|
> `optional` **noteTypeName**: `string`
|
|
98
98
|
|
|
99
|
-
Defined in: [types.ts:
|
|
99
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L376)
|
|
100
100
|
|
|
101
101
|
Anki note type name
|
|
102
102
|
|
|
@@ -110,7 +110,7 @@ Anki note type name
|
|
|
110
110
|
|
|
111
111
|
> **reading**: `string`
|
|
112
112
|
|
|
113
|
-
Defined in: [types.ts:
|
|
113
|
+
Defined in: [types.ts:652](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L652)
|
|
114
114
|
|
|
115
115
|
The romaji reading of the kana
|
|
116
116
|
|
|
@@ -120,7 +120,7 @@ The romaji reading of the kana
|
|
|
120
120
|
|
|
121
121
|
> `optional` **svg**: `string`
|
|
122
122
|
|
|
123
|
-
Defined in: [types.ts:
|
|
123
|
+
Defined in: [types.ts:660](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L660)
|
|
124
124
|
|
|
125
125
|
The kana SVG filename
|
|
126
126
|
|
|
@@ -130,7 +130,7 @@ The kana SVG filename
|
|
|
130
130
|
|
|
131
131
|
> `optional` **tags**: `string`[]
|
|
132
132
|
|
|
133
|
-
Defined in: [types.ts:
|
|
133
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L384)
|
|
134
134
|
|
|
135
135
|
Tags generated based on the entry's information
|
|
136
136
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Kanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L476)
|
|
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:508](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L508)
|
|
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:
|
|
35
|
+
Defined in: [types.ts:380](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L380)
|
|
36
36
|
|
|
37
37
|
The full path of the Anki deck
|
|
38
38
|
|
|
@@ -46,7 +46,7 @@ The full path of the Anki deck
|
|
|
46
46
|
|
|
47
47
|
> `optional` **doNotCreateNote**: `true`
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:
|
|
49
|
+
Defined in: [types.ts:388](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L388)
|
|
50
50
|
|
|
51
51
|
Whether or not this entry should be converted into an Anki note
|
|
52
52
|
|
|
@@ -60,7 +60,7 @@ Whether or not this entry should be converted into an Anki note
|
|
|
60
60
|
|
|
61
61
|
> `optional` **frequency**: `string`
|
|
62
62
|
|
|
63
|
-
Defined in: [types.ts:
|
|
63
|
+
Defined in: [types.ts:524](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L524)
|
|
64
64
|
|
|
65
65
|
#### See
|
|
66
66
|
|
|
@@ -72,7 +72,7 @@ Defined in: [types.ts:506](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
72
72
|
|
|
73
73
|
> `optional` **fromJpdb**: `true`
|
|
74
74
|
|
|
75
|
-
Defined in: [types.ts:
|
|
75
|
+
Defined in: [types.ts:536](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L536)
|
|
76
76
|
|
|
77
77
|
Whether or not this kanji object contains information **only** from `jpdb.io`
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ Whether or not this kanji object contains information **only** from `jpdb.io`
|
|
|
82
82
|
|
|
83
83
|
> `optional` **grade**: `string`
|
|
84
84
|
|
|
85
|
-
Defined in: [types.ts:
|
|
85
|
+
Defined in: [types.ts:520](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L520)
|
|
86
86
|
|
|
87
87
|
#### See
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Defined in: [types.ts:502](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
94
94
|
|
|
95
95
|
> `readonly` `optional` **id**: `string`
|
|
96
96
|
|
|
97
|
-
Defined in: [types.ts:
|
|
97
|
+
Defined in: [types.ts:372](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L372)
|
|
98
98
|
|
|
99
99
|
ID used for the Anki note ID
|
|
100
100
|
|
|
@@ -108,7 +108,7 @@ ID used for the Anki note ID
|
|
|
108
108
|
|
|
109
109
|
> `readonly` **kanji**: `string`
|
|
110
110
|
|
|
111
|
-
Defined in: [types.ts:
|
|
111
|
+
Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L480)
|
|
112
112
|
|
|
113
113
|
#### See
|
|
114
114
|
|
|
@@ -116,11 +116,21 @@ Defined in: [types.ts:462](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
116
116
|
|
|
117
117
|
***
|
|
118
118
|
|
|
119
|
+
### kokuji?
|
|
120
|
+
|
|
121
|
+
> `optional` **kokuji**: `true`
|
|
122
|
+
|
|
123
|
+
Defined in: [types.ts:528](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L528)
|
|
124
|
+
|
|
125
|
+
Whether or not the kanji is kokuji
|
|
126
|
+
|
|
127
|
+
***
|
|
128
|
+
|
|
119
129
|
### kunyomi?
|
|
120
130
|
|
|
121
131
|
> `optional` **kunyomi**: `string`[]
|
|
122
132
|
|
|
123
|
-
Defined in: [types.ts:
|
|
133
|
+
Defined in: [types.ts:496](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L496)
|
|
124
134
|
|
|
125
135
|
The kanji kunyomi readings
|
|
126
136
|
|
|
@@ -130,7 +140,7 @@ The kanji kunyomi readings
|
|
|
130
140
|
|
|
131
141
|
> `optional` **meanings**: `string`[]
|
|
132
142
|
|
|
133
|
-
Defined in: [types.ts:
|
|
143
|
+
Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L488)
|
|
134
144
|
|
|
135
145
|
#### See
|
|
136
146
|
|
|
@@ -142,7 +152,7 @@ Defined in: [types.ts:470](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
142
152
|
|
|
143
153
|
> `optional` **mnemonic**: `string`
|
|
144
154
|
|
|
145
|
-
Defined in: [types.ts:
|
|
155
|
+
Defined in: [types.ts:512](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L512)
|
|
146
156
|
|
|
147
157
|
The kanji mnemonic
|
|
148
158
|
|
|
@@ -152,7 +162,7 @@ The kanji mnemonic
|
|
|
152
162
|
|
|
153
163
|
> `optional` **nanori**: `string`[]
|
|
154
164
|
|
|
155
|
-
Defined in: [types.ts:
|
|
165
|
+
Defined in: [types.ts:500](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L500)
|
|
156
166
|
|
|
157
167
|
#### See
|
|
158
168
|
|
|
@@ -164,7 +174,7 @@ Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
164
174
|
|
|
165
175
|
> `readonly` `optional` **noteID**: `` `kanji_${string}` ``
|
|
166
176
|
|
|
167
|
-
Defined in: [types.ts:
|
|
177
|
+
Defined in: [types.ts:368](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L368)
|
|
168
178
|
|
|
169
179
|
ID used for the resulting Anki note
|
|
170
180
|
|
|
@@ -178,7 +188,7 @@ ID used for the resulting Anki note
|
|
|
178
188
|
|
|
179
189
|
> `optional` **noteTypeName**: `string`
|
|
180
190
|
|
|
181
|
-
Defined in: [types.ts:
|
|
191
|
+
Defined in: [types.ts:376](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L376)
|
|
182
192
|
|
|
183
193
|
Anki note type name
|
|
184
194
|
|
|
@@ -192,7 +202,7 @@ Anki note type name
|
|
|
192
202
|
|
|
193
203
|
> `optional` **onyomi**: `string`[]
|
|
194
204
|
|
|
195
|
-
Defined in: [types.ts:
|
|
205
|
+
Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L492)
|
|
196
206
|
|
|
197
207
|
The kanji onyomi readings
|
|
198
208
|
|
|
@@ -202,7 +212,7 @@ The kanji onyomi readings
|
|
|
202
212
|
|
|
203
213
|
> `optional` **source**: `string`
|
|
204
214
|
|
|
205
|
-
Defined in: [types.ts:
|
|
215
|
+
Defined in: [types.ts:532](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L532)
|
|
206
216
|
|
|
207
217
|
The source (besides KANJIDIC) from which data for this kanji has been extracted
|
|
208
218
|
|
|
@@ -212,7 +222,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
|
|
|
212
222
|
|
|
213
223
|
> `optional` **strokes**: `string`
|
|
214
224
|
|
|
215
|
-
Defined in: [types.ts:
|
|
225
|
+
Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L484)
|
|
216
226
|
|
|
217
227
|
#### See
|
|
218
228
|
|
|
@@ -224,7 +234,7 @@ Defined in: [types.ts:466](https://github.com/Ronokof/Henkan/blob/0242f1c5122d34
|
|
|
224
234
|
|
|
225
235
|
> `optional` **svg**: `string`
|
|
226
236
|
|
|
227
|
-
Defined in: [types.ts:
|
|
237
|
+
Defined in: [types.ts:504](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L504)
|
|
228
238
|
|
|
229
239
|
The kanji SVG filename
|
|
230
240
|
|
|
@@ -234,7 +244,7 @@ The kanji SVG filename
|
|
|
234
244
|
|
|
235
245
|
> `optional` **tags**: `string`[]
|
|
236
246
|
|
|
237
|
-
Defined in: [types.ts:
|
|
247
|
+
Defined in: [types.ts:384](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L384)
|
|
238
248
|
|
|
239
249
|
Tags generated based on the entry's information
|
|
240
250
|
|
|
@@ -248,6 +258,6 @@ Tags generated based on the entry's information
|
|
|
248
258
|
|
|
249
259
|
> `optional` **words**: [`Word`](Word.md)[]
|
|
250
260
|
|
|
251
|
-
Defined in: [types.ts:
|
|
261
|
+
Defined in: [types.ts:516](https://github.com/Ronokof/Henkan/blob/17544df04e711a7f1119a1cdd6fdf0d29ac91844/src/types.ts#L516)
|
|
252
262
|
|
|
253
263
|
Words that use the kanji
|