henkan 0.0.2 → 0.1.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 (56) hide show
  1. package/dist/index.cjs.js +23 -16
  2. package/dist/index.cjs.js.map +2 -2
  3. package/dist/index.mjs +20 -13
  4. package/dist/index.mjs.map +2 -2
  5. package/dist/types/types.d.ts +10 -0
  6. package/dist/types/types.d.ts.map +1 -1
  7. package/dist/types/utils.d.ts.map +1 -1
  8. package/docs/api/functions/capitalizeString.md +1 -1
  9. package/docs/api/functions/convertJMdict.md +1 -1
  10. package/docs/api/functions/convertKanjiDic.md +1 -1
  11. package/docs/api/functions/convertKradFile.md +1 -1
  12. package/docs/api/functions/convertRadkFile.md +1 -1
  13. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  14. package/docs/api/functions/generateAnkiNote.md +1 -1
  15. package/docs/api/functions/generateAnkiNotesFile.md +3 -3
  16. package/docs/api/functions/getKanji.md +1 -1
  17. package/docs/api/functions/getKanjiExtended.md +1 -1
  18. package/docs/api/functions/getWord.md +1 -1
  19. package/docs/api/functions/isStringArray.md +1 -1
  20. package/docs/api/functions/isValidArray.md +1 -1
  21. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  22. package/docs/api/functions/makeSSML.md +1 -1
  23. package/docs/api/functions/shuffleArray.md +1 -1
  24. package/docs/api/functions/synthesizeSpeech.md +3 -3
  25. package/docs/api/interfaces/DictKanji.md +4 -4
  26. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  27. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  28. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  29. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  30. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  31. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  32. package/docs/api/interfaces/DictMeaning.md +11 -11
  33. package/docs/api/interfaces/DictRadical.md +4 -4
  34. package/docs/api/interfaces/DictReading.md +5 -5
  35. package/docs/api/interfaces/DictWord.md +5 -5
  36. package/docs/api/interfaces/ExamplePart.md +7 -7
  37. package/docs/api/interfaces/Grammar.md +14 -14
  38. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  39. package/docs/api/interfaces/Kana.md +10 -10
  40. package/docs/api/interfaces/Kanji.md +20 -20
  41. package/docs/api/interfaces/KanjiComponent.md +3 -3
  42. package/docs/api/interfaces/KanjiForm.md +3 -3
  43. package/docs/api/interfaces/Phrase.md +4 -4
  44. package/docs/api/interfaces/Radical.md +24 -14
  45. package/docs/api/interfaces/Reading.md +4 -4
  46. package/docs/api/interfaces/ResultEntry.md +6 -6
  47. package/docs/api/interfaces/TanakaExample.md +5 -5
  48. package/docs/api/interfaces/Translation.md +3 -3
  49. package/docs/api/interfaces/UsefulRegExps.md +9 -9
  50. package/docs/api/interfaces/Word.md +24 -12
  51. package/docs/api/type-aliases/Dict.md +1 -1
  52. package/docs/api/type-aliases/DictName.md +1 -1
  53. package/docs/api/type-aliases/EntryType.md +1 -1
  54. package/docs/api/type-aliases/JLPT.md +1 -1
  55. package/docs/api/type-aliases/Result.md +1 -1
  56. package/package.json +10 -10
package/docs/api/interfaces/DictReading.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictReading
8
8
 
9
- Defined in: types.ts:40
9
+ Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/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
21
+ Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/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
35
+ Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/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
45
+ Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/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
59
+ Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L44)
60
60
 
61
61
  The reading of the word
package/docs/api/interfaces/DictWord.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictWord
8
8
 
9
- Defined in: types.ts:125
9
+ Defined in: [types.ts:125](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L125)
10
10
 
11
11
  JMdict entry (word)
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `entry` JMdict element
18
18
 
19
19
  > `readonly` **id**: `string`
20
20
 
21
- Defined in: types.ts:129
21
+ Defined in: [types.ts:129](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L129)
22
22
 
23
23
  The entry sequence number
24
24
 
@@ -28,7 +28,7 @@ The entry sequence number
28
28
 
29
29
  > `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
30
30
 
31
- Defined in: types.ts:133
31
+ Defined in: [types.ts:133](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L133)
32
32
 
33
33
  The word's kanji forms
34
34
 
@@ -38,7 +38,7 @@ The word's kanji forms
38
38
 
39
39
  > **meanings**: [`DictMeaning`](DictMeaning.md)[]
40
40
 
41
- Defined in: types.ts:141
41
+ Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L141)
42
42
 
43
43
  The word's meanings/senses
44
44
 
@@ -48,6 +48,6 @@ The word's meanings/senses
48
48
 
49
49
  > **readings**: [`DictReading`](DictReading.md)[]
50
50
 
51
- Defined in: types.ts:137
51
+ Defined in: [types.ts:137](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L137)
52
52
 
53
53
  The word's readings
package/docs/api/interfaces/ExamplePart.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ExamplePart
8
8
 
9
- Defined in: types.ts:279
9
+ Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L279)
10
10
 
11
11
  A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
12
12
 
@@ -16,7 +16,7 @@ A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
16
16
 
17
17
  > **baseForm**: `string`
18
18
 
19
- Defined in: types.ts:283
19
+ Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L283)
20
20
 
21
21
  The common form in which the word is found in JMdict
22
22
 
@@ -26,7 +26,7 @@ The common form in which the word is found in JMdict
26
26
 
27
27
  > `optional` **edited**: `true`
28
28
 
29
- Defined in: types.ts:307
29
+ Defined in: [types.ts:307](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L307)
30
30
 
31
31
  Whether or not the word is part of an entry that has been edited and adapted
32
32
 
@@ -40,7 +40,7 @@ Whether or not the word is part of an entry that has been edited and adapted
40
40
 
41
41
  > `optional` **glossNumber**: `number`
42
42
 
43
- Defined in: types.ts:291
43
+ Defined in: [types.ts:291](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L291)
44
44
 
45
45
  The JMdict sense number corresponding to the word’s usage in the phrase
46
46
 
@@ -50,7 +50,7 @@ The JMdict sense number corresponding to the word’s usage in the phrase
50
50
 
51
51
  > `optional` **inflectedForm**: `string`
52
52
 
53
- Defined in: types.ts:295
53
+ Defined in: [types.ts:295](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L295)
54
54
 
55
55
  The actual form in which the word is used in the phrase
56
56
 
@@ -60,7 +60,7 @@ The actual form in which the word is used in the phrase
60
60
 
61
61
  > `optional` **reading**: `string`
62
62
 
63
- Defined in: types.ts:287
63
+ Defined in: [types.ts:287](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L287)
64
64
 
65
65
  The reading (in kana) of the word
66
66
 
@@ -70,6 +70,6 @@ The reading (in kana) of the word
70
70
 
71
71
  > `optional` **referenceID**: `string`
72
72
 
73
- Defined in: types.ts:299
73
+ Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L299)
74
74
 
75
75
  A sequence number that references a JMdict entry associated with the word
package/docs/api/interfaces/Grammar.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Grammar
8
8
 
9
- Defined in: types.ts:634
9
+ Defined in: [types.ts:644](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L644)
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:666
23
+ Defined in: [types.ts:676](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L676)
24
24
 
25
25
  The filename of an audio file for the grammar point
26
26
 
@@ -30,7 +30,7 @@ The filename of an audio file for the grammar point
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: types.ts:366
33
+ Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
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
  > `readonly` `optional` **id**: `string`
46
46
 
47
- Defined in: types.ts:358
47
+ Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
48
48
 
49
49
  ID used for the Anki note ID
50
50
 
@@ -58,7 +58,7 @@ ID used for the Anki note ID
58
58
 
59
59
  > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
60
60
 
61
- Defined in: types.ts:658
61
+ Defined in: [types.ts:668](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L668)
62
62
 
63
63
  The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Test\_format) level
64
64
 
@@ -68,7 +68,7 @@ The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficie
68
68
 
69
69
  > **meaning**: [`GrammarMeaning`](GrammarMeaning.md)
70
70
 
71
- Defined in: types.ts:642
71
+ Defined in: [types.ts:652](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L652)
72
72
 
73
73
  The English meaning/translation of the grammar point
74
74
 
@@ -78,7 +78,7 @@ The English meaning/translation of the grammar point
78
78
 
79
79
  > `readonly` `optional` **noteID**: `` `grammar_${string}` ``
80
80
 
81
- Defined in: types.ts:354
81
+ Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
82
82
 
83
83
  ID used for the resulting Anki note
84
84
 
@@ -92,7 +92,7 @@ ID used for the resulting Anki note
92
92
 
93
93
  > `optional` **noteTypeName**: `string`
94
94
 
95
- Defined in: types.ts:362
95
+ Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
96
96
 
97
97
  Anki note type name
98
98
 
@@ -106,7 +106,7 @@ Anki note type name
106
106
 
107
107
  > `optional` **phrases**: [`Phrase`](Phrase.md)[]
108
108
 
109
- Defined in: types.ts:654
109
+ Defined in: [types.ts:664](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L664)
110
110
 
111
111
  Example phrase using the grammar point
112
112
 
@@ -116,7 +116,7 @@ Example phrase using the grammar point
116
116
 
117
117
  > `readonly` **point**: `string`
118
118
 
119
- Defined in: types.ts:638
119
+ Defined in: [types.ts:648](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L648)
120
120
 
121
121
  The most common form in which the grammar point written in
122
122
 
@@ -126,7 +126,7 @@ The most common form in which the grammar point written in
126
126
 
127
127
  > `optional` **readings**: [`Reading`](Reading.md)[]
128
128
 
129
- Defined in: types.ts:646
129
+ Defined in: [types.ts:656](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L656)
130
130
 
131
131
  The readings of the grammar point
132
132
 
@@ -136,7 +136,7 @@ The readings of the grammar point
136
136
 
137
137
  > `optional` **source**: `string`
138
138
 
139
- Defined in: types.ts:662
139
+ Defined in: [types.ts:672](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L672)
140
140
 
141
141
  The source from which data for this grammar point has been extracted
142
142
 
@@ -146,7 +146,7 @@ The source from which data for this grammar point has been extracted
146
146
 
147
147
  > `optional` **tags**: `string`[]
148
148
 
149
- Defined in: types.ts:370
149
+ Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
150
150
 
151
151
  Tags generated based on the entry's information
152
152
 
@@ -160,6 +160,6 @@ Tags generated based on the entry's information
160
160
 
161
161
  > `optional` **usages**: `string`[]
162
162
 
163
- Defined in: types.ts:650
163
+ Defined in: [types.ts:660](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L660)
164
164
 
165
165
  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:620
9
+ Defined in: [types.ts:630](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L630)
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:628
19
+ Defined in: [types.ts:638](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L638)
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:624
29
+ Defined in: [types.ts:634](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L634)
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:598
9
+ Defined in: [types.ts:608](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L608)
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:610
23
+ Defined in: [types.ts:620](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L620)
24
24
 
25
25
  The filename of an audio file for the kana reading
26
26
 
@@ -30,7 +30,7 @@ The filename of an audio file for the kana reading
30
30
 
31
31
  > `optional` **deckPath**: `string`
32
32
 
33
- Defined in: types.ts:366
33
+ Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
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
  > `readonly` `optional` **id**: `string`
46
46
 
47
- Defined in: types.ts:358
47
+ Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
48
48
 
49
49
  ID used for the Anki note ID
50
50
 
@@ -58,7 +58,7 @@ ID used for the Anki note ID
58
58
 
59
59
  > `readonly` **kana**: `string`
60
60
 
61
- Defined in: types.ts:602
61
+ Defined in: [types.ts:612](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L612)
62
62
 
63
63
  The kana character
64
64
 
@@ -68,7 +68,7 @@ The kana character
68
68
 
69
69
  > `readonly` `optional` **noteID**: `` `kana_${string}` ``
70
70
 
71
- Defined in: types.ts:354
71
+ Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
72
72
 
73
73
  ID used for the resulting Anki note
74
74
 
@@ -82,7 +82,7 @@ ID used for the resulting Anki note
82
82
 
83
83
  > `optional` **noteTypeName**: `string`
84
84
 
85
- Defined in: types.ts:362
85
+ Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
86
86
 
87
87
  Anki note type name
88
88
 
@@ -96,7 +96,7 @@ Anki note type name
96
96
 
97
97
  > **reading**: `string`
98
98
 
99
- Defined in: types.ts:606
99
+ Defined in: [types.ts:616](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L616)
100
100
 
101
101
  The romaji reading of the kana
102
102
 
@@ -106,7 +106,7 @@ The romaji reading of the kana
106
106
 
107
107
  > `optional` **svg**: `string`
108
108
 
109
- Defined in: types.ts:614
109
+ Defined in: [types.ts:624](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L624)
110
110
 
111
111
  The kana SVG filename
112
112
 
@@ -116,7 +116,7 @@ The kana SVG filename
116
116
 
117
117
  > `optional` **tags**: `string`[]
118
118
 
119
- Defined in: types.ts:370
119
+ Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
120
120
 
121
121
  Tags generated based on the entry's information
122
122
 
package/docs/api/interfaces/Kanji.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kanji
8
8
 
9
- Defined in: types.ts:444
9
+ Defined in: [types.ts:444](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L444)
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:476
25
+ Defined in: [types.ts:476](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L476)
26
26
 
27
27
  The kanji radicals/components
28
28
 
@@ -32,7 +32,7 @@ The kanji radicals/components
32
32
 
33
33
  > `optional` **deckPath**: `string`
34
34
 
35
- Defined in: types.ts:366
35
+ Defined in: [types.ts:366](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L366)
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` **frequency**: `string`
48
48
 
49
- Defined in: types.ts:492
49
+ Defined in: [types.ts:492](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L492)
50
50
 
51
51
  #### See
52
52
 
@@ -58,7 +58,7 @@ Defined in: types.ts:492
58
58
 
59
59
  > `optional` **fromJpdb**: `true`
60
60
 
61
- Defined in: types.ts:500
61
+ Defined in: [types.ts:500](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L500)
62
62
 
63
63
  Whether or not this kanji object contains information **only** from `jpdb.io`
64
64
 
@@ -68,7 +68,7 @@ Whether or not this kanji object contains information **only** from `jpdb.io`
68
68
 
69
69
  > `optional` **grade**: `string`
70
70
 
71
- Defined in: types.ts:488
71
+ Defined in: [types.ts:488](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L488)
72
72
 
73
73
  #### See
74
74
 
@@ -80,7 +80,7 @@ Defined in: types.ts:488
80
80
 
81
81
  > `readonly` `optional` **id**: `string`
82
82
 
83
- Defined in: types.ts:358
83
+ Defined in: [types.ts:358](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L358)
84
84
 
85
85
  ID used for the Anki note ID
86
86
 
@@ -94,7 +94,7 @@ ID used for the Anki note ID
94
94
 
95
95
  > `readonly` **kanji**: `string`
96
96
 
97
- Defined in: types.ts:448
97
+ Defined in: [types.ts:448](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L448)
98
98
 
99
99
  #### See
100
100
 
@@ -106,7 +106,7 @@ Defined in: types.ts:448
106
106
 
107
107
  > `optional` **kunyomi**: `string`[]
108
108
 
109
- Defined in: types.ts:464
109
+ Defined in: [types.ts:464](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L464)
110
110
 
111
111
  The kanji kunyomi readings
112
112
 
@@ -116,7 +116,7 @@ The kanji kunyomi readings
116
116
 
117
117
  > `optional` **meanings**: `string`[]
118
118
 
119
- Defined in: types.ts:456
119
+ Defined in: [types.ts:456](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L456)
120
120
 
121
121
  #### See
122
122
 
@@ -128,7 +128,7 @@ Defined in: types.ts:456
128
128
 
129
129
  > `optional` **mnemonic**: `string`
130
130
 
131
- Defined in: types.ts:480
131
+ Defined in: [types.ts:480](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L480)
132
132
 
133
133
  The kanji mnemonic
134
134
 
@@ -138,7 +138,7 @@ The kanji mnemonic
138
138
 
139
139
  > `optional` **nanori**: `string`[]
140
140
 
141
- Defined in: types.ts:468
141
+ Defined in: [types.ts:468](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L468)
142
142
 
143
143
  #### See
144
144
 
@@ -150,7 +150,7 @@ Defined in: types.ts:468
150
150
 
151
151
  > `readonly` `optional` **noteID**: `` `kanji_${string}` ``
152
152
 
153
- Defined in: types.ts:354
153
+ Defined in: [types.ts:354](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L354)
154
154
 
155
155
  ID used for the resulting Anki note
156
156
 
@@ -164,7 +164,7 @@ ID used for the resulting Anki note
164
164
 
165
165
  > `optional` **noteTypeName**: `string`
166
166
 
167
- Defined in: types.ts:362
167
+ Defined in: [types.ts:362](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L362)
168
168
 
169
169
  Anki note type name
170
170
 
@@ -178,7 +178,7 @@ Anki note type name
178
178
 
179
179
  > `optional` **onyomi**: `string`[]
180
180
 
181
- Defined in: types.ts:460
181
+ Defined in: [types.ts:460](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L460)
182
182
 
183
183
  The kanji onyomi readings
184
184
 
@@ -188,7 +188,7 @@ The kanji onyomi readings
188
188
 
189
189
  > `optional` **source**: `string`
190
190
 
191
- Defined in: types.ts:496
191
+ Defined in: [types.ts:496](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L496)
192
192
 
193
193
  The source (besides KANJIDIC) from which data for this kanji has been extracted
194
194
 
@@ -198,7 +198,7 @@ The source (besides KANJIDIC) from which data for this kanji has been extracted
198
198
 
199
199
  > `optional` **strokes**: `string`
200
200
 
201
- Defined in: types.ts:452
201
+ Defined in: [types.ts:452](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L452)
202
202
 
203
203
  #### See
204
204
 
@@ -210,7 +210,7 @@ Defined in: types.ts:452
210
210
 
211
211
  > `optional` **svg**: `string`
212
212
 
213
- Defined in: types.ts:472
213
+ Defined in: [types.ts:472](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L472)
214
214
 
215
215
  The kanji SVG filename
216
216
 
@@ -220,7 +220,7 @@ The kanji SVG filename
220
220
 
221
221
  > `optional` **tags**: `string`[]
222
222
 
223
- Defined in: types.ts:370
223
+ Defined in: [types.ts:370](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L370)
224
224
 
225
225
  Tags generated based on the entry's information
226
226
 
@@ -234,6 +234,6 @@ Tags generated based on the entry's information
234
234
 
235
235
  > `optional` **words**: [`Word`](Word.md)[]
236
236
 
237
- Defined in: types.ts:484
237
+ Defined in: [types.ts:484](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L484)
238
238
 
239
239
  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:428
9
+ Defined in: [types.ts:428](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L428)
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:432
19
+ Defined in: [types.ts:432](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L432)
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:436
29
+ Defined in: [types.ts:436](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L436)
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:378
9
+ Defined in: [types.ts:378](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L378)
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
  > `readonly` **kanjiForm**: `string`
20
20
 
21
- Defined in: types.ts:382
21
+ Defined in: [types.ts:382](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L382)
22
22
 
23
23
  The kanji form
24
24
 
@@ -28,6 +28,6 @@ The kanji form
28
28
 
29
29
  > `optional` **notes**: `string`[]
30
30
 
31
- Defined in: types.ts:386
31
+ Defined in: [types.ts:386](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L386)
32
32
 
33
33
  Optional notes for the kanji form
package/docs/api/interfaces/Phrase.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Phrase
8
8
 
9
- Defined in: types.ts:546
9
+ Defined in: [types.ts:550](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L550)
10
10
 
11
11
  Phrase information
12
12
 
@@ -18,7 +18,7 @@ Converted from [TanakaExample](TanakaExample.md)
18
18
 
19
19
  > `readonly` **originalPhrase**: `string`
20
20
 
21
- Defined in: types.ts:558
21
+ Defined in: [types.ts:562](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L562)
22
22
 
23
23
  #### See
24
24
 
@@ -30,7 +30,7 @@ Defined in: types.ts:558
30
30
 
31
31
  > `readonly` **phrase**: `string`
32
32
 
33
- Defined in: types.ts:550
33
+ Defined in: [types.ts:554](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L554)
34
34
 
35
35
  The Japanese phrase, either with furigana attached or not
36
36
 
@@ -40,7 +40,7 @@ The Japanese phrase, either with furigana attached or not
40
40
 
41
41
  > `readonly` **translation**: `string`
42
42
 
43
- Defined in: types.ts:554
43
+ Defined in: [types.ts:558](https://github.com/Ronokof/Henkan/blob/a8409ff59a4d15090def2ea20c6de370a8a9f4b3/src/types.ts#L558)
44
44
 
45
45
  #### See
46
46