henkan 0.9.3 → 1.0.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.
Files changed (68) hide show
  1. package/CONTRIBUTING.md +0 -0
  2. package/LICENSE.md +0 -0
  3. package/README.md +1 -1
  4. package/SECURITY.md +0 -0
  5. package/dist/index.cjs.js +358 -53
  6. package/dist/index.cjs.js.map +2 -2
  7. package/dist/index.mjs +353 -53
  8. package/dist/index.mjs.map +2 -2
  9. package/dist/types/types.d.ts +45 -7
  10. package/dist/types/types.d.ts.map +1 -1
  11. package/dist/types/utils.d.ts +32 -11
  12. package/dist/types/utils.d.ts.map +1 -1
  13. package/docs/api/README.md +5 -0
  14. package/docs/api/functions/capitalizeString.md +1 -1
  15. package/docs/api/functions/convertJMdict.md +1 -1
  16. package/docs/api/functions/convertJawiktionary.md +29 -0
  17. package/docs/api/functions/convertKanjiDic.md +1 -1
  18. package/docs/api/functions/convertKradFile.md +1 -1
  19. package/docs/api/functions/convertRadkFile.md +1 -1
  20. package/docs/api/functions/convertTanakaCorpus.md +2 -2
  21. package/docs/api/functions/generateAnkiNote.md +1 -1
  22. package/docs/api/functions/generateAnkiNotesFile.md +4 -4
  23. package/docs/api/functions/getKanji.md +12 -6
  24. package/docs/api/functions/getKanjiExtended.md +17 -11
  25. package/docs/api/functions/getWord.md +8 -2
  26. package/docs/api/functions/getWordDefinitions.md +45 -0
  27. package/docs/api/functions/isStringArray.md +1 -1
  28. package/docs/api/functions/isValidArray.md +1 -1
  29. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  30. package/docs/api/functions/shuffleArray.md +1 -1
  31. package/docs/api/functions/synthesizeSpeech.md +1 -1
  32. package/docs/api/interfaces/Definition.md +41 -0
  33. package/docs/api/interfaces/DictKanji.md +7 -7
  34. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  35. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  36. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  37. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  38. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  39. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  40. package/docs/api/interfaces/DictMeaning.md +12 -12
  41. package/docs/api/interfaces/DictRadical.md +4 -4
  42. package/docs/api/interfaces/DictReading.md +5 -5
  43. package/docs/api/interfaces/DictWord.md +8 -8
  44. package/docs/api/interfaces/ExamplePart.md +7 -7
  45. package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
  46. package/docs/api/interfaces/Grammar.md +15 -15
  47. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  48. package/docs/api/interfaces/Kana.md +11 -11
  49. package/docs/api/interfaces/Kanji.md +22 -22
  50. package/docs/api/interfaces/KanjiComponent.md +3 -3
  51. package/docs/api/interfaces/KanjiForm.md +4 -4
  52. package/docs/api/interfaces/NoteAndTag.md +3 -3
  53. package/docs/api/interfaces/Phrase.md +5 -5
  54. package/docs/api/interfaces/Radical.md +16 -16
  55. package/docs/api/interfaces/Reading.md +5 -5
  56. package/docs/api/interfaces/ResultEntry.md +7 -7
  57. package/docs/api/interfaces/TanakaExample.md +7 -7
  58. package/docs/api/interfaces/Translation.md +3 -3
  59. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  60. package/docs/api/interfaces/Word.md +24 -14
  61. package/docs/api/interfaces/WordDefinitionPair.md +31 -0
  62. package/docs/api/type-aliases/Dict.md +3 -3
  63. package/docs/api/type-aliases/DictName.md +1 -1
  64. package/docs/api/type-aliases/DictTranslation.md +13 -0
  65. package/docs/api/type-aliases/EntryType.md +1 -1
  66. package/docs/api/type-aliases/JLPT.md +1 -1
  67. package/docs/api/type-aliases/Result.md +1 -1
  68. package/package.json +17 -10
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Radical
8
8
 
9
- Defined in: [types.ts:578](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L578)
9
+ Defined in: [types.ts:617](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L617)
10
10
 
11
11
  Kanji radical/component information
12
12
 
@@ -20,7 +20,7 @@ Kanji radical/component information
20
20
 
21
21
  > `optional` **deckPath**: `string`
22
22
 
23
- Defined in: [types.ts:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
23
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L447)
24
24
 
25
25
  The full path of the Anki deck
26
26
 
@@ -34,7 +34,7 @@ The full path of the Anki deck
34
34
 
35
35
  > `optional` **doNotCreateNote**: `true`
36
36
 
37
- Defined in: [types.ts:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
37
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L455)
38
38
 
39
39
  Whether or not this entry should be converted into an Anki note
40
40
 
@@ -48,7 +48,7 @@ Whether or not this entry should be converted into an Anki note
48
48
 
49
49
  > `optional` **fromJpdb**: `true`
50
50
 
51
- Defined in: [types.ts:614](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L614)
51
+ Defined in: [types.ts:653](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L653)
52
52
 
53
53
  Whether or not this radical/component object contains information **only** from `jpdb.io`
54
54
 
@@ -58,7 +58,7 @@ Whether or not this radical/component object contains information **only** from
58
58
 
59
59
  > `readonly` `optional` **id**: `string`
60
60
 
61
- Defined in: [types.ts:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
61
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L439)
62
62
 
63
63
  ID used for the Anki note ID
64
64
 
@@ -72,7 +72,7 @@ ID used for the Anki note ID
72
72
 
73
73
  > `optional` **kanji**: [`Kanji`](Kanji.md)[]
74
74
 
75
- Defined in: [types.ts:606](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L606)
75
+ Defined in: [types.ts:645](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L645)
76
76
 
77
77
  Kanji that include the radical/component
78
78
 
@@ -82,7 +82,7 @@ Kanji that include the radical/component
82
82
 
83
83
  > **meanings**: `string`[]
84
84
 
85
- Defined in: [types.ts:590](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L590)
85
+ Defined in: [types.ts:629](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L629)
86
86
 
87
87
  The radical/component meanings
88
88
 
@@ -92,7 +92,7 @@ The radical/component meanings
92
92
 
93
93
  > `optional` **mnemonic**: `string`
94
94
 
95
- Defined in: [types.ts:602](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L602)
95
+ Defined in: [types.ts:641](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L641)
96
96
 
97
97
  The radical/component mnemonic
98
98
 
@@ -102,7 +102,7 @@ The radical/component mnemonic
102
102
 
103
103
  > `readonly` `optional` **noteID**: `` `radical_${string}` ``
104
104
 
105
- Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
105
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L435)
106
106
 
107
107
  ID used for the resulting Anki note
108
108
 
@@ -116,7 +116,7 @@ ID used for the resulting Anki note
116
116
 
117
117
  > `optional` **noteTypeName**: `string`
118
118
 
119
- Defined in: [types.ts:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
119
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L443)
120
120
 
121
121
  Anki note type name
122
122
 
@@ -130,7 +130,7 @@ Anki note type name
130
130
 
131
131
  > `readonly` **radical**: `string`
132
132
 
133
- Defined in: [types.ts:582](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L582)
133
+ Defined in: [types.ts:621](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L621)
134
134
 
135
135
  The radical/component character
136
136
 
@@ -140,7 +140,7 @@ The radical/component character
140
140
 
141
141
  > **reading**: `string`
142
142
 
143
- Defined in: [types.ts:586](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L586)
143
+ Defined in: [types.ts:625](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L625)
144
144
 
145
145
  The radical/component reading (in kana)
146
146
 
@@ -150,7 +150,7 @@ The radical/component reading (in kana)
150
150
 
151
151
  > `optional` **sources**: `string`[]
152
152
 
153
- Defined in: [types.ts:610](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L610)
153
+ Defined in: [types.ts:649](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L649)
154
154
 
155
155
  The sources from which data for this radical/component has been extracted
156
156
 
@@ -160,7 +160,7 @@ The sources from which data for this radical/component has been extracted
160
160
 
161
161
  > `optional` **strokes**: `string`
162
162
 
163
- Defined in: [types.ts:594](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L594)
163
+ Defined in: [types.ts:633](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L633)
164
164
 
165
165
  The stroke count of the radical/component
166
166
 
@@ -170,7 +170,7 @@ The stroke count of the radical/component
170
170
 
171
171
  > `optional` **svg**: `string`
172
172
 
173
- Defined in: [types.ts:598](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L598)
173
+ Defined in: [types.ts:637](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L637)
174
174
 
175
175
  The radical/component SVG filename
176
176
 
@@ -180,7 +180,7 @@ The radical/component SVG filename
180
180
 
181
181
  > `optional` **tags**: `string`[]
182
182
 
183
- Defined in: [types.ts:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
183
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L451)
184
184
 
185
185
  Tags generated based on the entry's information
186
186
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Reading
8
8
 
9
- Defined in: [types.ts:458](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L458)
9
+ Defined in: [types.ts:497](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L497)
10
10
 
11
11
  A reading of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from [DictReading](DictReading.md)
18
18
 
19
19
  > `optional` **audio**: `string`
20
20
 
21
- Defined in: [types.ts:474](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L474)
21
+ Defined in: [types.ts:513](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L513)
22
22
 
23
23
  The filename of an audio file for the reading
24
24
 
@@ -28,7 +28,7 @@ The filename of an audio file for the reading
28
28
 
29
29
  > `optional` **common**: `true`
30
30
 
31
- Defined in: [types.ts:470](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L470)
31
+ Defined in: [types.ts:509](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L509)
32
32
 
33
33
  Whether or not the reading is common
34
34
 
@@ -38,7 +38,7 @@ Whether or not the reading is common
38
38
 
39
39
  > `optional` **notes**: `string`[]
40
40
 
41
- Defined in: [types.ts:466](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L466)
41
+ Defined in: [types.ts:505](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L505)
42
42
 
43
43
  Optional notes for the reading
44
44
 
@@ -48,6 +48,6 @@ Optional notes for the reading
48
48
 
49
49
  > `readonly` **reading**: `string`
50
50
 
51
- Defined in: [types.ts:462](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L462)
51
+ Defined in: [types.ts:501](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L501)
52
52
 
53
53
  The reading (in kana)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ResultEntry\<EntryType\>
8
8
 
9
- Defined in: [types.ts:392](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L392)
9
+ Defined in: [types.ts:431](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L431)
10
10
 
11
11
  Basic Anki note information
12
12
 
@@ -30,7 +30,7 @@ Basic Anki note information
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: [types.ts:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
33
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L447)
34
34
 
35
35
  The full path of the Anki deck
36
36
 
@@ -40,7 +40,7 @@ The full path of the Anki deck
40
40
 
41
41
  > `optional` **doNotCreateNote**: `true`
42
42
 
43
- Defined in: [types.ts:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
43
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L455)
44
44
 
45
45
  Whether or not this entry should be converted into an Anki note
46
46
 
@@ -50,7 +50,7 @@ Whether or not this entry should be converted into an Anki note
50
50
 
51
51
  > `readonly` `optional` **id**: `string`
52
52
 
53
- Defined in: [types.ts:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
53
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L439)
54
54
 
55
55
  ID used for the Anki note ID
56
56
 
@@ -60,7 +60,7 @@ ID used for the Anki note ID
60
60
 
61
61
  > `readonly` `optional` **noteID**: `` `${EntryType}_${string}` ``
62
62
 
63
- Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
63
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L435)
64
64
 
65
65
  ID used for the resulting Anki note
66
66
 
@@ -70,7 +70,7 @@ ID used for the resulting Anki note
70
70
 
71
71
  > `optional` **noteTypeName**: `string`
72
72
 
73
- Defined in: [types.ts:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
73
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L443)
74
74
 
75
75
  Anki note type name
76
76
 
@@ -80,6 +80,6 @@ Anki note type name
80
80
 
81
81
  > `optional` **tags**: `string`[]
82
82
 
83
- Defined in: [types.ts:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
83
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L451)
84
84
 
85
85
  Tags generated based on the entry's information
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: TanakaExample
8
8
 
9
- Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L347)
9
+ Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L353)
10
10
 
11
11
  Tanaka Corpus `examples.utf` examples
12
12
 
@@ -16,7 +16,7 @@ Tanaka Corpus `examples.utf` examples
16
16
 
17
17
  > `readonly` `optional` **furigana**: `string`
18
18
 
19
- Defined in: [types.ts:367](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L367)
19
+ Defined in: [types.ts:373](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L373)
20
20
 
21
21
  The Japanese phrase, with furigana attached
22
22
 
@@ -26,7 +26,7 @@ The Japanese phrase, with furigana attached
26
26
 
27
27
  > `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
28
28
 
29
- Defined in: [types.ts:371](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L371)
29
+ Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L377)
30
30
 
31
31
  The word-gloss pair
32
32
 
@@ -36,7 +36,7 @@ The word-gloss pair
36
36
 
37
37
  > `readonly` **id**: `` `${number}_${number}` ``
38
38
 
39
- Defined in: [types.ts:351](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L351)
39
+ Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L357)
40
40
 
41
41
  The ID of the example
42
42
 
@@ -46,7 +46,7 @@ The ID of the example
46
46
 
47
47
  > `readonly` **parts**: [`ExamplePart`](ExamplePart.md)[]
48
48
 
49
- Defined in: [types.ts:363](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L363)
49
+ Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L369)
50
50
 
51
51
  The `B` section, split into parts
52
52
 
@@ -56,7 +56,7 @@ The `B` section, split into parts
56
56
 
57
57
  > `readonly` **phrase**: `string`
58
58
 
59
- Defined in: [types.ts:355](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L355)
59
+ Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L361)
60
60
 
61
61
  The Japanese phrase (found in the `A` section, **before** the tab)
62
62
 
@@ -66,6 +66,6 @@ The Japanese phrase (found in the `A` section, **before** the tab)
66
66
 
67
67
  > `readonly` **translation**: `string`
68
68
 
69
- Defined in: [types.ts:359](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L359)
69
+ Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L365)
70
70
 
71
71
  The English translation of the phrase (found in the `A` section, **after** the tab)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Translation
8
8
 
9
- Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L482)
9
+ Defined in: [types.ts:521](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L521)
10
10
 
11
11
  A translation of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from [DictMeaning](DictMeaning.md)
18
18
 
19
19
  > `optional` **notes**: `string`[]
20
20
 
21
- Defined in: [types.ts:490](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L490)
21
+ Defined in: [types.ts:529](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L529)
22
22
 
23
23
  Information about the translation
24
24
 
@@ -28,6 +28,6 @@ Information about the translation
28
28
 
29
29
  > `readonly` **translation**: `string`
30
30
 
31
- Defined in: [types.ts:486](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L486)
31
+ Defined in: [types.ts:525](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L525)
32
32
 
33
33
  The translation
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: UsefulRegExps
8
8
 
9
- Defined in: [types.ts:759](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L759)
9
+ Defined in: [types.ts:802](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L802)
10
10
 
11
11
  Some useful regular expressions
12
12
 
@@ -16,7 +16,7 @@ Some useful regular expressions
16
16
 
17
17
  > `readonly` **hiragana**: `RegExp`
18
18
 
19
- Defined in: [types.ts:763](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L763)
19
+ Defined in: [types.ts:806](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L806)
20
20
 
21
21
  Matches any *hiragana* character(s)
22
22
 
@@ -26,7 +26,7 @@ Matches any *hiragana* character(s)
26
26
 
27
27
  > `readonly` **kanji**: `RegExp`
28
28
 
29
- Defined in: [types.ts:771](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L771)
29
+ Defined in: [types.ts:814](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L814)
30
30
 
31
31
  Matches any *kanji* character(s)
32
32
 
@@ -36,7 +36,7 @@ Matches any *kanji* character(s)
36
36
 
37
37
  > `readonly` **katakana**: `RegExp`
38
38
 
39
- Defined in: [types.ts:767](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L767)
39
+ Defined in: [types.ts:810](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L810)
40
40
 
41
41
  Matches any *katakana* character(s)
42
42
 
@@ -46,7 +46,7 @@ Matches any *katakana* character(s)
46
46
 
47
47
  > `readonly` **regExChars**: `RegExp`
48
48
 
49
- Defined in: [types.ts:775](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L775)
49
+ Defined in: [types.ts:818](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L818)
50
50
 
51
51
  Matches any character that is part of the regex syntax
52
52
 
@@ -56,7 +56,7 @@ Matches any character that is part of the regex syntax
56
56
 
57
57
  > `readonly` **tanakaID**: `RegExp`
58
58
 
59
- Defined in: [types.ts:779](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L779)
59
+ Defined in: [types.ts:822](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L822)
60
60
 
61
61
  Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
62
62
 
@@ -66,7 +66,7 @@ Matches the `#ID=` part in a Tanaka Corpus `examples.utf` file
66
66
 
67
67
  > `readonly` **tanakaPart**: `RegExp`
68
68
 
69
- Defined in: [types.ts:783](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L783)
69
+ Defined in: [types.ts:826](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L826)
70
70
 
71
71
  Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.utf` file
72
72
 
@@ -76,6 +76,6 @@ Matches and splits a part found in the `B` section of a Tanaka Corpus `examples.
76
76
 
77
77
  > `readonly` **tanakaReferenceID**: `RegExp`
78
78
 
79
- Defined in: [types.ts:787](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L787)
79
+ Defined in: [types.ts:830](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L830)
80
80
 
81
81
  Matches the reference ID element of a Tanaka example part
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Word
8
8
 
9
- Defined in: [types.ts:646](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L646)
9
+ Defined in: [types.ts:685](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L685)
10
10
 
11
11
  Word information
12
12
 
@@ -22,7 +22,7 @@ Converted from [DictWord](DictWord.md)
22
22
 
23
23
  > `optional` **common**: `true`
24
24
 
25
- Defined in: [types.ts:670](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L670)
25
+ Defined in: [types.ts:713](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L713)
26
26
 
27
27
  #### See
28
28
 
@@ -34,7 +34,7 @@ Defined in: [types.ts:670](https://github.com/Ronokof/Henkan/blob/023926521f50f4
34
34
 
35
35
  > `optional` **deckPath**: `string`
36
36
 
37
- Defined in: [types.ts:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
37
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L447)
38
38
 
39
39
  The full path of the Anki deck
40
40
 
@@ -44,11 +44,21 @@ The full path of the Anki deck
44
44
 
45
45
  ***
46
46
 
47
+ ### definitions?
48
+
49
+ > `optional` **definitions**: [`Definition`](Definition.md)[]
50
+
51
+ Defined in: [types.ts:709](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L709)
52
+
53
+ Japanese definitions associated with the word
54
+
55
+ ***
56
+
47
57
  ### doNotCreateNote?
48
58
 
49
59
  > `optional` **doNotCreateNote**: `true`
50
60
 
51
- Defined in: [types.ts:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
61
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L455)
52
62
 
53
63
  Whether or not this entry should be converted into an Anki note
54
64
 
@@ -62,7 +72,7 @@ Whether or not this entry should be converted into an Anki note
62
72
 
63
73
  > `readonly` `optional` **id**: `string`
64
74
 
65
- Defined in: [types.ts:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
75
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L439)
66
76
 
67
77
  ID used for the Anki note ID
68
78
 
@@ -76,7 +86,7 @@ ID used for the Anki note ID
76
86
 
77
87
  > `optional` **kanji**: [`Kanji`](Kanji.md)[]
78
88
 
79
- Defined in: [types.ts:662](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L662)
89
+ Defined in: [types.ts:701](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L701)
80
90
 
81
91
  A list of kanji used in the kanji forms
82
92
 
@@ -86,7 +96,7 @@ A list of kanji used in the kanji forms
86
96
 
87
97
  > `optional` **kanjiForms**: [`KanjiForm`](KanjiForm.md)[]
88
98
 
89
- Defined in: [types.ts:658](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L658)
99
+ Defined in: [types.ts:697](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L697)
90
100
 
91
101
  The word kanji forms
92
102
 
@@ -96,7 +106,7 @@ The word kanji forms
96
106
 
97
107
  > `readonly` `optional` **noteID**: `` `word_${string}` ``
98
108
 
99
- Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
109
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L435)
100
110
 
101
111
  ID used for the resulting Anki note
102
112
 
@@ -110,7 +120,7 @@ ID used for the resulting Anki note
110
120
 
111
121
  > `optional` **noteTypeName**: `string`
112
122
 
113
- Defined in: [types.ts:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
123
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L443)
114
124
 
115
125
  Anki note type name
116
126
 
@@ -124,7 +134,7 @@ Anki note type name
124
134
 
125
135
  > `optional` **phrases**: [`Phrase`](Phrase.md)[]
126
136
 
127
- Defined in: [types.ts:666](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L666)
137
+ Defined in: [types.ts:705](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L705)
128
138
 
129
139
  Phrases associated to the word
130
140
 
@@ -134,7 +144,7 @@ Phrases associated to the word
134
144
 
135
145
  > **readings**: [`Reading`](Reading.md)[]
136
146
 
137
- Defined in: [types.ts:650](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L650)
147
+ Defined in: [types.ts:689](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L689)
138
148
 
139
149
  The word readings (in kana)
140
150
 
@@ -144,7 +154,7 @@ The word readings (in kana)
144
154
 
145
155
  > `optional` **tags**: `string`[]
146
156
 
147
- Defined in: [types.ts:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
157
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L451)
148
158
 
149
159
  Tags generated based on the entry's information
150
160
 
@@ -158,7 +168,7 @@ Tags generated based on the entry's information
158
168
 
159
169
  > **translations**: [`Translation`](Translation.md)[]
160
170
 
161
- Defined in: [types.ts:654](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L654)
171
+ Defined in: [types.ts:693](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L693)
162
172
 
163
173
  The word translations/senses
164
174
 
@@ -168,7 +178,7 @@ The word translations/senses
168
178
 
169
179
  > `optional` **usuallyInKana**: `true`
170
180
 
171
- Defined in: [types.ts:674](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L674)
181
+ Defined in: [types.ts:717](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L717)
172
182
 
173
183
  #### See
174
184
 
@@ -0,0 +1,31 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / WordDefinitionPair
6
+
7
+ # Interface: WordDefinitionPair
8
+
9
+ Defined in: [types.ts:401](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L401)
10
+
11
+ A word paired with its definitions
12
+
13
+ ## Properties
14
+
15
+ ### definitions
16
+
17
+ > **definitions**: [`Definition`](Definition.md)[]
18
+
19
+ Defined in: [types.ts:409](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L409)
20
+
21
+ The word definitions
22
+
23
+ ***
24
+
25
+ ### wordID
26
+
27
+ > **wordID**: `string`
28
+
29
+ Defined in: [types.ts:405](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L405)
30
+
31
+ The word's JMdict entry ID
@@ -6,8 +6,8 @@
6
6
 
7
7
  # Type Alias: Dict
8
8
 
9
- > **Dict** = [`DictWord`](../interfaces/DictWord.md)[] \| [`DictKanji`](../interfaces/DictKanji.md)[] \| [`TanakaExample`](../interfaces/TanakaExample.md)[] \| [`DictRadical`](../interfaces/DictRadical.md)[] \| [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
9
+ > **Dict** = [`DictWord`](../interfaces/DictWord.md)[] \| [`DictKanji`](../interfaces/DictKanji.md)[] \| [`TanakaExample`](../interfaces/TanakaExample.md)[] \| [`DictRadical`](../interfaces/DictRadical.md)[] \| [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[] \| [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
10
10
 
11
- Defined in: [types.ts:377](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L377)
11
+ Defined in: [types.ts:415](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L415)
12
12
 
13
- Any type of entry list
13
+ Types of converted dictionary entries
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **DictName** = `"JMDict"` \| `"Kanjidic"` \| `"tanaka"` \| `"radk"` \| `"krad"`
10
10
 
11
- Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L9)
11
+ Defined in: [types.ts:9](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L9)
12
12
 
13
13
  Standardized dictionary names
@@ -0,0 +1,13 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / DictTranslation
6
+
7
+ # Type Alias: DictTranslation
8
+
9
+ > **DictTranslation** = `string` \| \{ `translation`: `string`; `type`: `"lit"` \| `"expl"` \| `"tm"`; \}
10
+
11
+ Defined in: [types.ts:66](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L66)
12
+
13
+ A JMdict sense translation
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **EntryType** = `"word"` \| `"kanji"` \| `"radical"` \| `"kana"` \| `"grammar"`
10
10
 
11
- Defined in: [types.ts:387](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L387)
11
+ Defined in: [types.ts:426](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L426)
12
12
 
13
13
  Names of entry types used for the Anki note IDs
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **JLPT** = `"N5"` \| `"N4"` \| `"N3"` \| `"N2"` \| `"N1"`
10
10
 
11
- Defined in: [types.ts:4](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L4)
11
+ Defined in: [types.ts:4](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L4)
12
12
 
13
13
  JLPT levels
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **Result** = [`Word`](../interfaces/Word.md) \| [`Kanji`](../interfaces/Kanji.md) \| [`Radical`](../interfaces/Radical.md) \| [`Kana`](../interfaces/Kana.md) \| [`Grammar`](../interfaces/Grammar.md)
10
10
 
11
- Defined in: [types.ts:754](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L754)
11
+ Defined in: [types.ts:797](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L797)
12
12
 
13
13
  Any type of converted entry from a [Dict](Dict.md) array + others not from a dictionary