henkan 0.9.3 → 1.0.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.
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 +43 -5
  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 +1 -1
  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 +16 -9
package/docs/api/interfaces/Grammar.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Grammar
8
8
 
9
- Defined in: [types.ts:716](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L716)
9
+ Defined in: [types.ts:758](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L758)
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:748](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L748)
23
+ Defined in: [types.ts:790](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L790)
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:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
33
+ Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L446)
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:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
47
+ Defined in: [types.ts:454](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L454)
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:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
61
+ Defined in: [types.ts:438](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L438)
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:740](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L740)
75
+ Defined in: [types.ts:782](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L782)
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:724](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L724)
85
+ Defined in: [types.ts:766](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L766)
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:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
95
+ Defined in: [types.ts:434](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L434)
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:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
109
+ Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L442)
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:736](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L736)
123
+ Defined in: [types.ts:778](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L778)
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:720](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L720)
133
+ Defined in: [types.ts:762](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L762)
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:728](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L728)
143
+ Defined in: [types.ts:770](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L770)
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:744](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L744)
153
+ Defined in: [types.ts:786](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L786)
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:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
163
+ Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L450)
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:732](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L732)
177
+ Defined in: [types.ts:774](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L774)
178
178
 
179
179
  Ways in which the grammar point is used in Japanese
package/docs/api/interfaces/GrammarMeaning.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: GrammarMeaning
8
8
 
9
- Defined in: [types.ts:702](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L702)
9
+ Defined in: [types.ts:744](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L744)
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:710](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L710)
19
+ Defined in: [types.ts:752](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L752)
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:706](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L706)
29
+ Defined in: [types.ts:748](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L748)
30
30
 
31
31
  The meaning of the grammar point
package/docs/api/interfaces/Kana.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kana
8
8
 
9
- Defined in: [types.ts:680](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L680)
9
+ Defined in: [types.ts:722](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L722)
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:692](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L692)
23
+ Defined in: [types.ts:734](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L734)
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:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
33
+ Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L446)
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:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
47
+ Defined in: [types.ts:454](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L454)
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:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
61
+ Defined in: [types.ts:438](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L438)
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:684](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L684)
75
+ Defined in: [types.ts:726](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L726)
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:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
85
+ Defined in: [types.ts:434](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L434)
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:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
99
+ Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L442)
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:688](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L688)
113
+ Defined in: [types.ts:730](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L730)
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:696](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L696)
123
+ Defined in: [types.ts:738](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L738)
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:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
133
+ Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L450)
134
134
 
135
135
  Tags generated based on the entry's information
136
136
 
package/docs/api/interfaces/Kanji.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kanji
8
8
 
9
- Defined in: [types.ts:512](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L512)
9
+ Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L550)
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:544](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L544)
25
+ Defined in: [types.ts:582](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L582)
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:408](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L408)
35
+ Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L446)
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:416](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L416)
49
+ Defined in: [types.ts:454](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L454)
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:560](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L560)
63
+ Defined in: [types.ts:598](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L598)
64
64
 
65
65
  #### See
66
66
 
@@ -72,7 +72,7 @@ Defined in: [types.ts:560](https://github.com/Ronokof/Henkan/blob/023926521f50f4
72
72
 
73
73
  > `optional` **fromJpdb**: `true`
74
74
 
75
- Defined in: [types.ts:572](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L572)
75
+ Defined in: [types.ts:610](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L610)
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:556](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L556)
85
+ Defined in: [types.ts:594](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L594)
86
86
 
87
87
  #### See
88
88
 
@@ -94,7 +94,7 @@ Defined in: [types.ts:556](https://github.com/Ronokof/Henkan/blob/023926521f50f4
94
94
 
95
95
  > `readonly` `optional` **id**: `string`
96
96
 
97
- Defined in: [types.ts:400](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L400)
97
+ Defined in: [types.ts:438](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L438)
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:516](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L516)
111
+ Defined in: [types.ts:554](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L554)
112
112
 
113
113
  #### See
114
114
 
@@ -120,7 +120,7 @@ Defined in: [types.ts:516](https://github.com/Ronokof/Henkan/blob/023926521f50f4
120
120
 
121
121
  > `optional` **kokuji**: `true`
122
122
 
123
- Defined in: [types.ts:564](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L564)
123
+ Defined in: [types.ts:602](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L602)
124
124
 
125
125
  Whether or not the kanji is kokuji
126
126
 
@@ -130,7 +130,7 @@ Whether or not the kanji is kokuji
130
130
 
131
131
  > `optional` **kunyomi**: `string`[]
132
132
 
133
- Defined in: [types.ts:532](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L532)
133
+ Defined in: [types.ts:570](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L570)
134
134
 
135
135
  The kanji kunyomi readings
136
136
 
@@ -140,7 +140,7 @@ The kanji kunyomi readings
140
140
 
141
141
  > `optional` **meanings**: `string`[]
142
142
 
143
- Defined in: [types.ts:524](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L524)
143
+ Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L562)
144
144
 
145
145
  #### See
146
146
 
@@ -152,7 +152,7 @@ Defined in: [types.ts:524](https://github.com/Ronokof/Henkan/blob/023926521f50f4
152
152
 
153
153
  > `optional` **mnemonic**: `string`
154
154
 
155
- Defined in: [types.ts:548](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L548)
155
+ Defined in: [types.ts:586](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L586)
156
156
 
157
157
  The kanji mnemonic
158
158
 
@@ -162,7 +162,7 @@ The kanji mnemonic
162
162
 
163
163
  > `optional` **nanori**: `string`[]
164
164
 
165
- Defined in: [types.ts:536](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L536)
165
+ Defined in: [types.ts:574](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L574)
166
166
 
167
167
  #### See
168
168
 
@@ -174,7 +174,7 @@ Defined in: [types.ts:536](https://github.com/Ronokof/Henkan/blob/023926521f50f4
174
174
 
175
175
  > `readonly` `optional` **noteID**: `` `kanji_${string}` ``
176
176
 
177
- Defined in: [types.ts:396](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L396)
177
+ Defined in: [types.ts:434](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L434)
178
178
 
179
179
  ID used for the resulting Anki note
180
180
 
@@ -188,7 +188,7 @@ ID used for the resulting Anki note
188
188
 
189
189
  > `optional` **noteTypeName**: `string`
190
190
 
191
- Defined in: [types.ts:404](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L404)
191
+ Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L442)
192
192
 
193
193
  Anki note type name
194
194
 
@@ -202,7 +202,7 @@ Anki note type name
202
202
 
203
203
  > `optional` **onyomi**: `string`[]
204
204
 
205
- Defined in: [types.ts:528](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L528)
205
+ Defined in: [types.ts:566](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L566)
206
206
 
207
207
  The kanji onyomi readings
208
208
 
@@ -212,7 +212,7 @@ The kanji onyomi readings
212
212
 
213
213
  > `optional` **source**: `string`
214
214
 
215
- Defined in: [types.ts:568](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L568)
215
+ Defined in: [types.ts:606](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L606)
216
216
 
217
217
  The source (besides KANJIDIC) from which data for this kanji has been extracted
218
218
 
@@ -222,7 +222,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
222
222
 
223
223
  > `optional` **strokes**: `string`
224
224
 
225
- Defined in: [types.ts:520](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L520)
225
+ Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L558)
226
226
 
227
227
  #### See
228
228
 
@@ -234,7 +234,7 @@ Defined in: [types.ts:520](https://github.com/Ronokof/Henkan/blob/023926521f50f4
234
234
 
235
235
  > `optional` **svg**: `string`
236
236
 
237
- Defined in: [types.ts:540](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L540)
237
+ Defined in: [types.ts:578](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L578)
238
238
 
239
239
  The kanji SVG filename
240
240
 
@@ -244,7 +244,7 @@ The kanji SVG filename
244
244
 
245
245
  > `optional` **tags**: `string`[]
246
246
 
247
- Defined in: [types.ts:412](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L412)
247
+ Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L450)
248
248
 
249
249
  Tags generated based on the entry's information
250
250
 
@@ -258,6 +258,6 @@ Tags generated based on the entry's information
258
258
 
259
259
  > `optional` **words**: [`Word`](Word.md)[]
260
260
 
261
- Defined in: [types.ts:552](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L552)
261
+ Defined in: [types.ts:590](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L590)
262
262
 
263
263
  Words that use the kanji
package/docs/api/interfaces/KanjiComponent.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiComponent
8
8
 
9
- Defined in: [types.ts:496](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L496)
9
+ Defined in: [types.ts:534](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L534)
10
10
 
11
11
  Kanji component information
12
12
 
@@ -16,7 +16,7 @@ Kanji component information
16
16
 
17
17
  > `readonly` **component**: `string`
18
18
 
19
- Defined in: [types.ts:500](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L500)
19
+ Defined in: [types.ts:538](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L538)
20
20
 
21
21
  The component character
22
22
 
@@ -26,6 +26,6 @@ The component character
26
26
 
27
27
  > `optional` **meaning**: `string`
28
28
 
29
- Defined in: [types.ts:504](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L504)
29
+ Defined in: [types.ts:542](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L542)
30
30
 
31
31
  The meaning of the component
package/docs/api/interfaces/KanjiForm.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: KanjiForm
8
8
 
9
- Defined in: [types.ts:438](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L438)
9
+ Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L476)
10
10
 
11
11
  A kanji form of the word
12
12
 
@@ -18,7 +18,7 @@ Converted from a [DictKanjiForm](DictKanjiForm.md)
18
18
 
19
19
  > `optional` **common**: `true`
20
20
 
21
- Defined in: [types.ts:450](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L450)
21
+ Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L488)
22
22
 
23
23
  Whether or not the kanji form is common
24
24
 
@@ -28,7 +28,7 @@ Whether or not the kanji form is common
28
28
 
29
29
  > `readonly` **kanjiForm**: `string`
30
30
 
31
- Defined in: [types.ts:442](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L442)
31
+ Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L480)
32
32
 
33
33
  The kanji form
34
34
 
@@ -38,6 +38,6 @@ The kanji form
38
38
 
39
39
  > `optional` **notes**: `string`[]
40
40
 
41
- Defined in: [types.ts:446](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L446)
41
+ Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L484)
42
42
 
43
43
  Optional notes for the kanji form
package/docs/api/interfaces/NoteAndTag.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: NoteAndTag
8
8
 
9
- Defined in: [types.ts:422](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L422)
9
+ Defined in: [types.ts:460](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L460)
10
10
 
11
11
  A pair of a "kanji form"/"reading"/"sense" note and its associated tag
12
12
 
@@ -16,7 +16,7 @@ A pair of a "kanji form"/"reading"/"sense" note and its associated tag
16
16
 
17
17
  > `readonly` `optional` **note**: `string`
18
18
 
19
- Defined in: [types.ts:426](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L426)
19
+ Defined in: [types.ts:464](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L464)
20
20
 
21
21
  The note
22
22
 
@@ -26,6 +26,6 @@ The note
26
26
 
27
27
  > `readonly` `optional` **tag**: `string`
28
28
 
29
- Defined in: [types.ts:430](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L430)
29
+ Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L468)
30
30
 
31
31
  The tag
package/docs/api/interfaces/Phrase.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Phrase
8
8
 
9
- Defined in: [types.ts:622](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L622)
9
+ Defined in: [types.ts:660](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L660)
10
10
 
11
11
  Phrase information
12
12
 
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
18
18
 
19
19
  > `readonly` `optional` **glossNumber**: [`GlossSpecificNumber`](GlossSpecificNumber.md)
20
20
 
21
- Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L638)
21
+ Defined in: [types.ts:676](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L676)
22
22
 
23
23
  #### See
24
24
 
@@ -30,7 +30,7 @@ Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/023926521f50f4
30
30
 
31
31
  > `readonly` **originalPhrase**: `string`
32
32
 
33
- Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L634)
33
+ Defined in: [types.ts:672](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L672)
34
34
 
35
35
  #### See
36
36
 
@@ -42,7 +42,7 @@ Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/023926521f50f4
42
42
 
43
43
  > `readonly` **phrase**: `string`
44
44
 
45
- Defined in: [types.ts:626](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L626)
45
+ Defined in: [types.ts:664](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L664)
46
46
 
47
47
  The Japanese phrase, either with furigana attached or not
48
48
 
@@ -52,7 +52,7 @@ The Japanese phrase, either with furigana attached or not
52
52
 
53
53
  > `readonly` **translation**: `string`
54
54
 
55
- Defined in: [types.ts:630](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L630)
55
+ Defined in: [types.ts:668](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/types.ts#L668)
56
56
 
57
57
  #### See
58
58