henkan 1.0.2 → 1.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 (63) hide show
  1. package/dist/index.cjs.js +10 -6
  2. package/dist/index.cjs.js.map +2 -2
  3. package/dist/index.mjs +7 -3
  4. package/dist/index.mjs.map +2 -2
  5. package/dist/types/types.d.ts +10 -6
  6. package/dist/types/types.d.ts.map +1 -1
  7. package/dist/types/utils.d.ts +2 -2
  8. package/dist/types/utils.d.ts.map +1 -1
  9. package/docs/api/functions/capitalizeString.md +1 -1
  10. package/docs/api/functions/convertJMdict.md +1 -1
  11. package/docs/api/functions/convertJawiktionary.md +2 -2
  12. package/docs/api/functions/convertKanjiDic.md +1 -1
  13. package/docs/api/functions/convertKradFile.md +1 -1
  14. package/docs/api/functions/convertRadkFile.md +1 -1
  15. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  16. package/docs/api/functions/generateAnkiNote.md +1 -1
  17. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  18. package/docs/api/functions/getKanji.md +1 -1
  19. package/docs/api/functions/getKanjiExtended.md +1 -1
  20. package/docs/api/functions/getWord.md +1 -1
  21. package/docs/api/functions/getWordDefinitions.md +1 -1
  22. package/docs/api/functions/isStringArray.md +1 -1
  23. package/docs/api/functions/isValidArray.md +1 -1
  24. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  25. package/docs/api/functions/shuffleArray.md +1 -1
  26. package/docs/api/functions/synthesizeSpeech.md +2 -2
  27. package/docs/api/interfaces/Definition.md +4 -4
  28. package/docs/api/interfaces/DictKanji.md +5 -5
  29. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  30. package/docs/api/interfaces/DictKanjiMisc.md +10 -10
  31. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  32. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  33. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  34. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  35. package/docs/api/interfaces/DictMeaning.md +11 -11
  36. package/docs/api/interfaces/DictRadical.md +4 -4
  37. package/docs/api/interfaces/DictReading.md +5 -5
  38. package/docs/api/interfaces/DictWord.md +8 -8
  39. package/docs/api/interfaces/ExamplePart.md +7 -7
  40. package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
  41. package/docs/api/interfaces/Grammar.md +16 -16
  42. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  43. package/docs/api/interfaces/Kana.md +11 -11
  44. package/docs/api/interfaces/Kanji.md +34 -22
  45. package/docs/api/interfaces/KanjiComponent.md +3 -3
  46. package/docs/api/interfaces/KanjiForm.md +4 -4
  47. package/docs/api/interfaces/NoteAndTag.md +3 -3
  48. package/docs/api/interfaces/Phrase.md +5 -5
  49. package/docs/api/interfaces/Radical.md +16 -16
  50. package/docs/api/interfaces/Reading.md +5 -5
  51. package/docs/api/interfaces/ResultEntry.md +7 -7
  52. package/docs/api/interfaces/TanakaExample.md +7 -7
  53. package/docs/api/interfaces/Translation.md +3 -3
  54. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  55. package/docs/api/interfaces/Word.md +15 -15
  56. package/docs/api/interfaces/WordDefinitionPair.md +3 -3
  57. package/docs/api/type-aliases/Dict.md +1 -1
  58. package/docs/api/type-aliases/DictName.md +1 -1
  59. package/docs/api/type-aliases/DictTranslation.md +1 -1
  60. package/docs/api/type-aliases/EntryType.md +1 -1
  61. package/docs/api/type-aliases/JLPT.md +1 -1
  62. package/docs/api/type-aliases/Result.md +1 -1
  63. package/package.json +3 -3
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictMeaning
8
8
 
9
- Defined in: [types.ts:75](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L75)
9
+ Defined in: [types.ts:75](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L75)
10
10
 
11
11
  Word meaning/sense information
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `sense` JMdict element
18
18
 
19
19
  > `optional` **antonyms**: `string`[]
20
20
 
21
- Defined in: [types.ts:101](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L101)
21
+ Defined in: [types.ts:101](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L101)
22
22
 
23
23
  References to antonyms of the word *(when used with this meaning)*
24
24
 
@@ -28,7 +28,7 @@ References to antonyms of the word *(when used with this meaning)*
28
28
 
29
29
  > `optional` **dialects**: `string`[]
30
30
 
31
- Defined in: [types.ts:123](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L123)
31
+ Defined in: [types.ts:123](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L123)
32
32
 
33
33
  Regional dialects the meaning is restricted to
34
34
 
@@ -42,7 +42,7 @@ Regional dialects the meaning is restricted to
42
42
 
43
43
  > `optional` **fields**: `string`[]
44
44
 
45
- Defined in: [types.ts:107](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L107)
45
+ Defined in: [types.ts:107](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L107)
46
46
 
47
47
  Field of application of the word *(when used with this meaning)*
48
48
 
@@ -56,7 +56,7 @@ Field of application of the word *(when used with this meaning)*
56
56
 
57
57
  > `optional` **info**: `string`[]
58
58
 
59
- Defined in: [types.ts:111](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L111)
59
+ Defined in: [types.ts:111](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L111)
60
60
 
61
61
  Additional information about the meaning
62
62
 
@@ -66,7 +66,7 @@ Additional information about the meaning
66
66
 
67
67
  > `optional` **kanjiFormRestrictions**: `string`[]
68
68
 
69
- Defined in: [types.ts:93](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L93)
69
+ Defined in: [types.ts:93](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L93)
70
70
 
71
71
  Kanji forms the meaning is restricted to
72
72
 
@@ -76,7 +76,7 @@ Kanji forms the meaning is restricted to
76
76
 
77
77
  > `optional` **misc**: `string`[]
78
78
 
79
- Defined in: [types.ts:117](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L117)
79
+ Defined in: [types.ts:117](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L117)
80
80
 
81
81
  Other relevant information about the meaning
82
82
 
@@ -90,7 +90,7 @@ Other relevant information about the meaning
90
90
 
91
91
  > `optional` **partOfSpeech**: `string`[]
92
92
 
93
- Defined in: [types.ts:81](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L81)
93
+ Defined in: [types.ts:81](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L81)
94
94
 
95
95
  Part of speech information
96
96
 
@@ -104,7 +104,7 @@ Part of speech information
104
104
 
105
105
  > `optional` **readingRestrictions**: `string`[]
106
106
 
107
- Defined in: [types.ts:97](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L97)
107
+ Defined in: [types.ts:97](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L97)
108
108
 
109
109
  Readings the meaning is restricted to
110
110
 
@@ -114,7 +114,7 @@ Readings the meaning is restricted to
114
114
 
115
115
  > `optional` **references**: `string`[]
116
116
 
117
- Defined in: [types.ts:89](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L89)
117
+ Defined in: [types.ts:89](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L89)
118
118
 
119
119
  Cross-references to other similar/related words *(when used with this meaning)*
120
120
 
@@ -124,6 +124,6 @@ Cross-references to other similar/related words *(when used with this meaning)*
124
124
 
125
125
  > `optional` **translations**: [`DictTranslation`](../type-aliases/DictTranslation.md)[]
126
126
 
127
- Defined in: [types.ts:85](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L85)
127
+ Defined in: [types.ts:85](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L85)
128
128
 
129
129
  Word glosses
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictRadical
8
8
 
9
- Defined in: [types.ts:271](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L271)
9
+ Defined in: [types.ts:271](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L271)
10
10
 
11
11
  RADKFILE2 entry (radical)
12
12
 
@@ -16,7 +16,7 @@ RADKFILE2 entry (radical)
16
16
 
17
17
  > `optional` **kanji**: [`DictKanji`](DictKanji.md)[]
18
18
 
19
- Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L283)
19
+ Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L283)
20
20
 
21
21
  The kanji that include the radical
22
22
 
@@ -26,7 +26,7 @@ The kanji that include the radical
26
26
 
27
27
  > `readonly` **radical**: `string`
28
28
 
29
- Defined in: [types.ts:275](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L275)
29
+ Defined in: [types.ts:275](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L275)
30
30
 
31
31
  The radical character
32
32
 
@@ -36,6 +36,6 @@ The radical character
36
36
 
37
37
  > `readonly` **strokes**: `string`
38
38
 
39
- Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L279)
39
+ Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L279)
40
40
 
41
41
  The stroke count of the radical
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictReading
8
8
 
9
- Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L40)
9
+ Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L40)
10
10
 
11
11
  Word reading information
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `r_ele` JMdict element
18
18
 
19
19
  > `optional` **commonness**: `string`[]
20
20
 
21
- Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L56)
21
+ Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L56)
22
22
 
23
23
  Priority codes
24
24
 
@@ -32,7 +32,7 @@ Priority codes
32
32
 
33
33
  > `optional` **kanjiFormRestrictions**: `string`[]
34
34
 
35
- Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L60)
35
+ Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L60)
36
36
 
37
37
  Kanji forms the reading is restricted to
38
38
 
@@ -42,7 +42,7 @@ Kanji forms the reading is restricted to
42
42
 
43
43
  > `optional` **notes**: `string`[]
44
44
 
45
- Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L50)
45
+ Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L50)
46
46
 
47
47
  Other information about the reading
48
48
 
@@ -56,6 +56,6 @@ Other information about the reading
56
56
 
57
57
  > `readonly` **reading**: `string`
58
58
 
59
- Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L44)
59
+ Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L44)
60
60
 
61
61
  The reading of the word
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictWord
8
8
 
9
- Defined in: [types.ts:131](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L131)
9
+ Defined in: [types.ts:131](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L131)
10
10
 
11
11
  JMdict entry (word)
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `entry` JMdict element + miscellaneous info
18
18
 
19
19
  > `optional` **hasPhrases**: `true`
20
20
 
21
- Defined in: [types.ts:163](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L163)
21
+ Defined in: [types.ts:163](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L163)
22
22
 
23
23
  Whether or not the entry has at least one Tanaka Corpus phrase associated with it
24
24
 
@@ -30,7 +30,7 @@ Whether or not the entry has at least one Tanaka Corpus phrase associated with i
30
30
 
31
31
  > `readonly` **id**: `string`
32
32
 
33
- Defined in: [types.ts:135](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L135)
33
+ Defined in: [types.ts:135](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L135)
34
34
 
35
35
  The entry sequence number
36
36
 
@@ -40,7 +40,7 @@ The entry sequence number
40
40
 
41
41
  > `optional` **isCommon**: `true`
42
42
 
43
- Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L151)
43
+ Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L151)
44
44
 
45
45
  Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
46
46
 
@@ -50,7 +50,7 @@ Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
50
50
 
51
51
  > `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
52
52
 
53
- Defined in: [types.ts:139](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L139)
53
+ Defined in: [types.ts:139](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L139)
54
54
 
55
55
  The word's kanji forms
56
56
 
@@ -60,7 +60,7 @@ The word's kanji forms
60
60
 
61
61
  > **meanings**: [`DictMeaning`](DictMeaning.md)[]
62
62
 
63
- Defined in: [types.ts:147](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L147)
63
+ Defined in: [types.ts:147](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L147)
64
64
 
65
65
  The word's meanings/senses
66
66
 
@@ -70,7 +70,7 @@ The word's meanings/senses
70
70
 
71
71
  > **readings**: [`DictReading`](DictReading.md)[]
72
72
 
73
- Defined in: [types.ts:143](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L143)
73
+ Defined in: [types.ts:143](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L143)
74
74
 
75
75
  The word's readings
76
76
 
@@ -80,7 +80,7 @@ The word's readings
80
80
 
81
81
  > `optional` **usuallyInKana**: `true`
82
82
 
83
- Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L157)
83
+ Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L157)
84
84
 
85
85
  Whether or not the word is typically written in kana alone
86
86
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ExamplePart
8
8
 
9
- Defined in: [types.ts:305](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L305)
9
+ Defined in: [types.ts:305](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L305)
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:309](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L309)
19
+ Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L309)
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:333](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L333)
29
+ Defined in: [types.ts:333](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L333)
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:317](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L317)
43
+ Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L317)
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:321](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L321)
53
+ Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L321)
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:313](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L313)
63
+ Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L313)
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:325](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L325)
73
+ Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L325)
74
74
 
75
75
  A sequence number that references a JMdict entry associated with the word
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: GlossSpecificNumber
8
8
 
9
- Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L339)
9
+ Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L339)
10
10
 
11
11
  A pair of a word ID and a number associated with a gloss number
12
12
 
@@ -16,7 +16,7 @@ A pair of a word ID and a number associated with a gloss number
16
16
 
17
17
  > `readonly` **glossNumber**: `number`
18
18
 
19
- Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L347)
19
+ Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L347)
20
20
 
21
21
  The entry's gloss number
22
22
 
@@ -26,6 +26,6 @@ The entry's gloss number
26
26
 
27
27
  > `readonly` **wordId**: `string`
28
28
 
29
- Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L343)
29
+ Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L343)
30
30
 
31
31
  The entry ID
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Grammar
8
8
 
9
- Defined in: [types.ts:759](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L759)
9
+ Defined in: [types.ts:763](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L763)
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:791](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L791)
23
+ Defined in: [types.ts:795](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L795)
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:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
33
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
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:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
47
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
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:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
61
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L439)
62
62
 
63
63
  ID used for the Anki note ID
64
64
 
@@ -72,9 +72,9 @@ 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:783](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L783)
75
+ Defined in: [types.ts:787](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L787)
76
76
 
77
- The \[post-2010 JLPT\](https://en.wikipedia.org/wiki/Japanese-Language\_Proficiency\_Test#Test\_format) level
77
+ The [post-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Test_format) level
78
78
 
79
79
  ***
80
80
 
@@ -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:767](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L767)
85
+ Defined in: [types.ts:771](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L771)
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:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
95
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L435)
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:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
109
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
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:779](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L779)
123
+ Defined in: [types.ts:783](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L783)
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:763](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L763)
133
+ Defined in: [types.ts:767](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L767)
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:771](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L771)
143
+ Defined in: [types.ts:775](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L775)
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:787](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L787)
153
+ Defined in: [types.ts:791](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L791)
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:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
163
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
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:775](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L775)
177
+ Defined in: [types.ts:779](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L779)
178
178
 
179
179
  Ways in which the grammar point is used in Japanese
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: GrammarMeaning
8
8
 
9
- Defined in: [types.ts:745](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L745)
9
+ Defined in: [types.ts:749](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L749)
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:753](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L753)
19
+ Defined in: [types.ts:757](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L757)
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:749](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L749)
29
+ Defined in: [types.ts:753](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L753)
30
30
 
31
31
  The meaning of the grammar point
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Kana
8
8
 
9
- Defined in: [types.ts:723](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L723)
9
+ Defined in: [types.ts:727](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L727)
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:735](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L735)
23
+ Defined in: [types.ts:739](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L739)
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:447](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L447)
33
+ Defined in: [types.ts:447](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L447)
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:455](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L455)
47
+ Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
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:439](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L439)
61
+ Defined in: [types.ts:439](https://github.com/Ronokof/Henkan/blob/main/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
  > `readonly` **kana**: `string`
74
74
 
75
- Defined in: [types.ts:727](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L727)
75
+ Defined in: [types.ts:731](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L731)
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:435](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L435)
85
+ Defined in: [types.ts:435](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L435)
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:443](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L443)
99
+ Defined in: [types.ts:443](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L443)
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:731](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L731)
113
+ Defined in: [types.ts:735](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L735)
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:739](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L739)
123
+ Defined in: [types.ts:743](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L743)
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:451](https://github.com/Ronokof/Henkan/blob/9ad653a73ab5f72333c02f441e9c1b857c01468b/src/types.ts#L451)
133
+ Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
134
134
 
135
135
  Tags generated based on the entry's information
136
136