henkan 0.6.1 → 0.7.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/README.md +1 -1
- package/dist/index.cjs.js +53 -34
- package/dist/index.cjs.js.map +3 -3
- package/dist/index.mjs +53 -36
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +21 -0
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +9 -6
- 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 +25 -13
- 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 +31 -0
- 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 +16 -4
- 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 +16 -6
- 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 +5 -5
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictMeaning
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:67](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:67](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L67)
|
|
10
10
|
|
|
11
11
|
Word meaning/sense information
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Equivalent to the `sense` JMdict element
|
|
|
18
18
|
|
|
19
19
|
> `optional` **antonyms**: `string`[]
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:95](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:95](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L95)
|
|
22
22
|
|
|
23
23
|
References to antonyms of the word *(when used with this meaning)*
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ References to antonyms of the word *(when used with this meaning)*
|
|
|
28
28
|
|
|
29
29
|
> `optional` **dialects**: `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [types.ts:117](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:117](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L117)
|
|
32
32
|
|
|
33
33
|
Regional dialects the meaning is restricted to
|
|
34
34
|
|
|
@@ -42,7 +42,7 @@ Regional dialects the meaning is restricted to
|
|
|
42
42
|
|
|
43
43
|
> `optional` **fields**: `string`[]
|
|
44
44
|
|
|
45
|
-
Defined in: [types.ts:101](https://github.com/Ronokof/Henkan/blob/
|
|
45
|
+
Defined in: [types.ts:101](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L101)
|
|
46
46
|
|
|
47
47
|
Field of application of the word *(when used with this meaning)*
|
|
48
48
|
|
|
@@ -56,7 +56,7 @@ Field of application of the word *(when used with this meaning)*
|
|
|
56
56
|
|
|
57
57
|
> `optional` **info**: `string`[]
|
|
58
58
|
|
|
59
|
-
Defined in: [types.ts:105](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:105](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L105)
|
|
60
60
|
|
|
61
61
|
Additional information about the meaning
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ Additional information about the meaning
|
|
|
66
66
|
|
|
67
67
|
> `optional` **kanjiFormRestrictions**: `string`[]
|
|
68
68
|
|
|
69
|
-
Defined in: [types.ts:87](https://github.com/Ronokof/Henkan/blob/
|
|
69
|
+
Defined in: [types.ts:87](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L87)
|
|
70
70
|
|
|
71
71
|
Kanji forms the meaning is restricted to
|
|
72
72
|
|
|
@@ -76,7 +76,7 @@ Kanji forms the meaning is restricted to
|
|
|
76
76
|
|
|
77
77
|
> `optional` **misc**: `string`[]
|
|
78
78
|
|
|
79
|
-
Defined in: [types.ts:111](https://github.com/Ronokof/Henkan/blob/
|
|
79
|
+
Defined in: [types.ts:111](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L111)
|
|
80
80
|
|
|
81
81
|
Other relevant information about the meaning
|
|
82
82
|
|
|
@@ -90,7 +90,7 @@ Other relevant information about the meaning
|
|
|
90
90
|
|
|
91
91
|
> `optional` **partOfSpeech**: `string`[]
|
|
92
92
|
|
|
93
|
-
Defined in: [types.ts:73](https://github.com/Ronokof/Henkan/blob/
|
|
93
|
+
Defined in: [types.ts:73](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L73)
|
|
94
94
|
|
|
95
95
|
Part of speech information
|
|
96
96
|
|
|
@@ -104,7 +104,7 @@ Part of speech information
|
|
|
104
104
|
|
|
105
105
|
> `optional` **readingRestrictions**: `string`[]
|
|
106
106
|
|
|
107
|
-
Defined in: [types.ts:91](https://github.com/Ronokof/Henkan/blob/
|
|
107
|
+
Defined in: [types.ts:91](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L91)
|
|
108
108
|
|
|
109
109
|
Readings the meaning is restricted to
|
|
110
110
|
|
|
@@ -114,7 +114,7 @@ Readings the meaning is restricted to
|
|
|
114
114
|
|
|
115
115
|
> `optional` **references**: `string`[]
|
|
116
116
|
|
|
117
|
-
Defined in: [types.ts:83](https://github.com/Ronokof/Henkan/blob/
|
|
117
|
+
Defined in: [types.ts:83](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L83)
|
|
118
118
|
|
|
119
119
|
Cross-references to other similar/related words *(when used with this meaning)*
|
|
120
120
|
|
|
@@ -124,6 +124,6 @@ Cross-references to other similar/related words *(when used with this meaning)*
|
|
|
124
124
|
|
|
125
125
|
> `optional` **translations**: (`string` \| \{ `translation`: `string`; `type`: `"lit"` \| `"expl"` \| `"tm"`; \})[]
|
|
126
126
|
|
|
127
|
-
Defined in: [types.ts:77](https://github.com/Ronokof/Henkan/blob/
|
|
127
|
+
Defined in: [types.ts:77](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L77)
|
|
128
128
|
|
|
129
129
|
Word glosses
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictRadical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L265)
|
|
10
10
|
|
|
11
11
|
RADKFILE2 entry (radical)
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ RADKFILE2 entry (radical)
|
|
|
16
16
|
|
|
17
17
|
> `optional` **kanji**: [`DictKanji`](DictKanji.md)[]
|
|
18
18
|
|
|
19
|
-
Defined in: [types.ts:277](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:277](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L277)
|
|
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:269](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:269](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L269)
|
|
30
30
|
|
|
31
31
|
The radical character
|
|
32
32
|
|
|
@@ -36,6 +36,6 @@ The radical character
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **strokes**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:273](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:273](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L273)
|
|
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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L125)
|
|
10
10
|
|
|
11
11
|
JMdict entry (word)
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Equivalent to the `entry` JMdict element + miscellaneous info
|
|
|
18
18
|
|
|
19
19
|
> `optional` **hasPhrases**: `true`
|
|
20
20
|
|
|
21
|
-
Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L157)
|
|
22
22
|
|
|
23
23
|
Whether or not the entry has at least one Tanaka Corpus phrase associated with it
|
|
24
24
|
|
|
@@ -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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L141)
|
|
64
64
|
|
|
65
65
|
The word's meanings/senses
|
|
66
66
|
|
|
@@ -70,7 +70,7 @@ 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/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L137)
|
|
74
74
|
|
|
75
75
|
The word's readings
|
|
76
76
|
|
|
@@ -80,7 +80,7 @@ The word's readings
|
|
|
80
80
|
|
|
81
81
|
> `optional` **usuallyInKana**: `true`
|
|
82
82
|
|
|
83
|
-
Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/
|
|
83
|
+
Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L151)
|
|
84
84
|
|
|
85
85
|
Whether or not the word is typically written in kana alone
|
|
86
86
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ExamplePart
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L299)
|
|
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:303](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:303](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L303)
|
|
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:327](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:327](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L327)
|
|
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:311](https://github.com/Ronokof/Henkan/blob/
|
|
43
|
+
Defined in: [types.ts:311](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L311)
|
|
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:315](https://github.com/Ronokof/Henkan/blob/
|
|
53
|
+
Defined in: [types.ts:315](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L315)
|
|
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:307](https://github.com/Ronokof/Henkan/blob/
|
|
63
|
+
Defined in: [types.ts:307](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L307)
|
|
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:319](https://github.com/Ronokof/Henkan/blob/
|
|
73
|
+
Defined in: [types.ts:319](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L319)
|
|
74
74
|
|
|
75
75
|
A sequence number that references a JMdict entry associated with the word
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**henkan**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[henkan](../README.md) / GlossSpecificNumber
|
|
6
|
+
|
|
7
|
+
# Interface: GlossSpecificNumber
|
|
8
|
+
|
|
9
|
+
Defined in: [types.ts:333](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L333)
|
|
10
|
+
|
|
11
|
+
A pair of a word ID and a number associated with a gloss number
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### glossNumber
|
|
16
|
+
|
|
17
|
+
> `readonly` **glossNumber**: `number`
|
|
18
|
+
|
|
19
|
+
Defined in: [types.ts:341](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L341)
|
|
20
|
+
|
|
21
|
+
The entry's gloss number
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### wordId
|
|
26
|
+
|
|
27
|
+
> `readonly` **wordId**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [types.ts:337](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L337)
|
|
30
|
+
|
|
31
|
+
The entry ID
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Grammar
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:716](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L716)
|
|
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:748](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L748)
|
|
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:408](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L408)
|
|
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:416](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L416)
|
|
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:400](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L400)
|
|
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:740](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L740)
|
|
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:724](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L724)
|
|
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:396](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L396)
|
|
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:404](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L404)
|
|
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:736](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L736)
|
|
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:720](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L720)
|
|
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:728](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L728)
|
|
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:744](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L744)
|
|
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:412](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L412)
|
|
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:732](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L732)
|
|
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:702](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L702)
|
|
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:710](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L710)
|
|
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:706](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L706)
|
|
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:680](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L680)
|
|
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:692](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L692)
|
|
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:408](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L408)
|
|
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:416](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L416)
|
|
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:400](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L400)
|
|
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:684](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L684)
|
|
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:396](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L396)
|
|
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:404](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L404)
|
|
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:688](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L688)
|
|
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:696](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L696)
|
|
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:412](https://github.com/Ronokof/Henkan/blob/5a5b65a6c9451f9ba9d8831d08b4643388bb91e5/src/types.ts#L412)
|
|
134
134
|
|
|
135
135
|
Tags generated based on the entry's information
|
|
136
136
|
|