henkan 2.0.4 → 2.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 (72) hide show
  1. package/dist/index.cjs.js +618 -691
  2. package/dist/index.cjs.js.map +2 -2
  3. package/dist/index.mjs +612 -686
  4. package/dist/index.mjs.map +2 -2
  5. package/dist/types/constants.d.ts.map +1 -1
  6. package/dist/types/types.d.ts +40 -19
  7. package/dist/types/types.d.ts.map +1 -1
  8. package/dist/types/utils.d.ts +32 -24
  9. package/dist/types/utils.d.ts.map +1 -1
  10. package/docs/api/README.md +4 -1
  11. package/docs/api/functions/capitalizeString.md +1 -1
  12. package/docs/api/functions/convertJMdict.md +1 -1
  13. package/docs/api/functions/convertJawiktionaryAsync.md +1 -1
  14. package/docs/api/functions/convertJawiktionarySync.md +1 -1
  15. package/docs/api/functions/convertKanjiDic.md +1 -1
  16. package/docs/api/functions/convertKradFile.md +1 -1
  17. package/docs/api/functions/convertRadkFile.md +1 -1
  18. package/docs/api/functions/convertTanakaCorpus.md +1 -1
  19. package/docs/api/functions/convertTanakaCorpusWithFurigana.md +1 -1
  20. package/docs/api/functions/generateAnkiNote.md +1 -1
  21. package/docs/api/functions/generateAnkiNotesFile.md +1 -1
  22. package/docs/api/functions/getKanji.md +7 -7
  23. package/docs/api/functions/getKanjiExtended.md +6 -6
  24. package/docs/api/functions/getValidForms.md +39 -0
  25. package/docs/api/functions/getWord.md +9 -9
  26. package/docs/api/functions/getWordDefinitions.md +1 -1
  27. package/docs/api/functions/getWordDefinitionsWithFurigana.md +1 -1
  28. package/docs/api/functions/isObjectArray.md +27 -0
  29. package/docs/api/functions/isStringArray.md +2 -2
  30. package/docs/api/functions/isValidArrayWithFirstElement.md +2 -2
  31. package/docs/api/functions/shuffleArray.md +1 -1
  32. package/docs/api/interfaces/DefaultNoteInfo.md +4 -4
  33. package/docs/api/interfaces/Definition.md +4 -4
  34. package/docs/api/interfaces/DictKanji.md +5 -5
  35. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  36. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  37. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  38. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  39. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  40. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  41. package/docs/api/interfaces/DictMeaning.md +15 -15
  42. package/docs/api/interfaces/DictRadical.md +4 -4
  43. package/docs/api/interfaces/DictReading.md +5 -5
  44. package/docs/api/interfaces/DictWord.md +9 -9
  45. package/docs/api/interfaces/ExamplePart.md +8 -8
  46. package/docs/api/interfaces/GlossSpecificNumber.md +4 -4
  47. package/docs/api/interfaces/Grammar.md +15 -15
  48. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  49. package/docs/api/interfaces/JaWiktionaryEntry.md +8 -20
  50. package/docs/api/interfaces/Kana.md +11 -11
  51. package/docs/api/interfaces/Kanji.md +24 -24
  52. package/docs/api/interfaces/KanjiComponent.md +3 -3
  53. package/docs/api/interfaces/KanjiForm.md +4 -4
  54. package/docs/api/interfaces/NoteAndTag.md +3 -3
  55. package/docs/api/interfaces/NoteHeaderKeys.md +7 -7
  56. package/docs/api/interfaces/Phrase.md +5 -5
  57. package/docs/api/interfaces/Radical.md +16 -16
  58. package/docs/api/interfaces/Reading.md +5 -5
  59. package/docs/api/interfaces/ReadingsKanjiFormsPair.md +31 -0
  60. package/docs/api/interfaces/ResultEntry.md +7 -7
  61. package/docs/api/interfaces/TanakaExample.md +7 -7
  62. package/docs/api/interfaces/Translation.md +3 -3
  63. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  64. package/docs/api/interfaces/Word.md +15 -15
  65. package/docs/api/interfaces/WordDefinitionPair.md +4 -4
  66. package/docs/api/type-aliases/Dict.md +1 -1
  67. package/docs/api/type-aliases/DictTranslation.md +1 -1
  68. package/docs/api/type-aliases/EntryType.md +1 -1
  69. package/docs/api/type-aliases/Result.md +1 -1
  70. package/docs/api/type-aliases/StringNumber.md +13 -0
  71. package/package.json +2 -2
  72. package/docs/api/functions/isValidArray.md +0 -27
@@ -8,9 +8,9 @@
8
8
 
9
9
  > **getWord**(`word`, `dict?`, `kanjiDic?`, `examples?`, `definitions?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md) \| `undefined`
10
10
 
11
- Defined in: [utils.ts:1611](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1611)
11
+ Defined in: [utils.ts:1528](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1528)
12
12
 
13
- Transforms a converted `JMdict` entry into a more readable format, by providing either its JMdict entry ID or the [DictWord](../interfaces/DictWord.md) object directly.
13
+ Transforms a converted `JMdict` entry into a more readable format, by providing either its JMdict entry ID (requires [dict](#getword)) or the [DictWord](../interfaces/DictWord.md) object directly.
14
14
 
15
15
  ## Parameters
16
16
 
@@ -22,27 +22,27 @@ The ID of the `JMdict` entry or a [DictWord](../interfaces/DictWord.md) object
22
22
 
23
23
  ### dict?
24
24
 
25
- readonly [`DictWord`](../interfaces/DictWord.md)[]
25
+ An array or an ID-entry map of converted `JMdict` entries (not needed if [word](#getword) is a [DictWord](../interfaces/DictWord.md) object)
26
26
 
27
- An array of converted `JMdict` entries (not needed if [word](#getword) is a [DictWord](../interfaces/DictWord.md) object)
27
+ readonly [`DictWord`](../interfaces/DictWord.md)[] | `Map`\<`` `${number}` ``, [`DictWord`](../interfaces/DictWord.md)\>
28
28
 
29
29
  ### kanjiDic?
30
30
 
31
- An array or an ID-kanji map of converted `KANJIDIC` entries
31
+ An array or an char-kanji map of converted `KANJIDIC` entries
32
32
 
33
33
  readonly [`DictKanji`](../interfaces/DictKanji.md)[] | `Map`\<`string`, readonly [`DictKanji`](../interfaces/DictKanji.md)[]\>
34
34
 
35
35
  ### examples?
36
36
 
37
- An array of converted `Tanaka Corpus` examples
37
+ An array or an ID-examples map of converted `Tanaka Corpus` examples
38
38
 
39
- readonly [`TanakaExample`](../interfaces/TanakaExample.md)[] | `Map`\<`string`, readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]\>
39
+ readonly [`TanakaExample`](../interfaces/TanakaExample.md)[] | `Map`\<`` `${number}` ``, readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]\>
40
40
 
41
41
  ### definitions?
42
42
 
43
43
  An array or ID-definitions map of `ja.wiktionary.org` word definitions
44
44
 
45
- `Map`\<`string`, readonly [`Definition`](../interfaces/Definition.md)[]\> | readonly [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
45
+ `Map`\<`` `${number}` ``, readonly [`Definition`](../interfaces/Definition.md)[]\> | readonly [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
46
46
 
47
47
  ### noteTypeName?
48
48
 
@@ -60,4 +60,4 @@ The full Anki deck path
60
60
 
61
61
  [`Word`](../interfaces/Word.md) \| `undefined`
62
62
 
63
- The transformed [Word](../interfaces/Word.md) object or `undefined` if entry is not found
63
+ The transformed [DictWord](../interfaces/DictWord.md) object or `undefined` if entry is not found
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getWordDefinitions**(`entryList`, `jmDict`): [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
10
10
 
11
- Defined in: [utils.ts:869](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L869)
11
+ Defined in: [utils.ts:835](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L835)
12
12
 
13
13
  Pairs Japanese definitions with JMdict word entries
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getWordDefinitionsWithFurigana**(`entryList`, `jmDict`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
10
10
 
11
- Defined in: [utils.ts:1533](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1533)
11
+ Defined in: [utils.ts:1450](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1450)
12
12
 
13
13
  Pairs Japanese definitions with JMdict word entries (with furigana)
14
14
 
@@ -0,0 +1,27 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / isObjectArray
6
+
7
+ # Function: isObjectArray()
8
+
9
+ > **isObjectArray**(`arg`): `arg is any[]`
10
+
11
+ Defined in: [utils.ts:87](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L87)
12
+
13
+ Checks if the argument is an array of object.
14
+
15
+ ## Parameters
16
+
17
+ ### arg
18
+
19
+ `unknown`
20
+
21
+ The argument
22
+
23
+ ## Returns
24
+
25
+ `arg is any[]`
26
+
27
+ Whether or not [arg](#isobjectarray) is an array of objects
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isStringArray**(`arg`): `arg is string[]`
10
10
 
11
- Defined in: [utils.ts:87](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L87)
11
+ Defined in: [utils.ts:75](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L75)
12
12
 
13
13
  Checks if the argument is an array of strings.
14
14
 
@@ -16,7 +16,7 @@ Checks if the argument is an array of strings.
16
16
 
17
17
  ### arg
18
18
 
19
- `any`
19
+ `unknown`
20
20
 
21
21
  The argument
22
22
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
10
10
 
11
- Defined in: [utils.ts:72](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L72)
11
+ Defined in: [utils.ts:66](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L66)
12
12
 
13
13
  Checks if the argument is an array and has at least one element.
14
14
 
@@ -16,7 +16,7 @@ Checks if the argument is an array and has at least one element.
16
16
 
17
17
  ### arg
18
18
 
19
- `any`
19
+ `unknown`
20
20
 
21
21
  The argument
22
22
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **shuffleArray**\<`T`\>(`arr`): `T`[]
10
10
 
11
- Defined in: [utils.ts:101](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L101)
11
+ Defined in: [utils.ts:99](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L99)
12
12
 
13
13
  Shuffles an array using the `Fisher–Yates shuffle` algorithm
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DefaultNoteInfo
8
8
 
9
- Defined in: [types.ts:883](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L883)
9
+ Defined in: [types.ts:910](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L910)
10
10
 
11
11
  Default note ID, note type and deck name of a note
12
12
 
@@ -24,7 +24,7 @@ Setting any of the properties to:
24
24
 
25
25
  > `optional` **deckPath**: `string` \| `true`
26
26
 
27
- Defined in: [types.ts:897](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L897)
27
+ Defined in: [types.ts:924](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L924)
28
28
 
29
29
  A default for [Result.deckPath](Grammar.md#deckpath)
30
30
 
@@ -34,7 +34,7 @@ A default for [Result.deckPath](Grammar.md#deckpath)
34
34
 
35
35
  > `optional` **guid**: `true` \| `"main_information"`
36
36
 
37
- Defined in: [types.ts:889](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L889)
37
+ Defined in: [types.ts:916](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L916)
38
38
 
39
39
  A default for [Result.noteID](Grammar.md#noteid)
40
40
 
@@ -46,6 +46,6 @@ A default for [Result.noteID](Grammar.md#noteid)
46
46
 
47
47
  > `optional` **noteType**: `string` \| `true`
48
48
 
49
- Defined in: [types.ts:893](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L893)
49
+ Defined in: [types.ts:920](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L920)
50
50
 
51
51
  A default for [Result.noteTypeName](Grammar.md#notetypename)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Definition
8
8
 
9
- Defined in: [types.ts:451](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L451)
9
+ Defined in: [types.ts:478](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L478)
10
10
 
11
11
  A word definition
12
12
 
@@ -16,7 +16,7 @@ A word definition
16
16
 
17
17
  > **definition**: `string`
18
18
 
19
- Defined in: [types.ts:455](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L455)
19
+ Defined in: [types.ts:482](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L482)
20
20
 
21
21
  The definition
22
22
 
@@ -26,7 +26,7 @@ The definition
26
26
 
27
27
  > `optional` **furigana**: `string`
28
28
 
29
- Defined in: [types.ts:459](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L459)
29
+ Defined in: [types.ts:486](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L486)
30
30
 
31
31
  The definition with furigana attached
32
32
 
@@ -36,6 +36,6 @@ The definition with furigana attached
36
36
 
37
37
  > `optional` **mayNotBeAccurate**: `true`
38
38
 
39
- Defined in: [types.ts:463](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L463)
39
+ Defined in: [types.ts:490](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L490)
40
40
 
41
41
  Whether or not the definition is associated with other words
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanji
8
8
 
9
- Defined in: [types.ts:290](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L290)
9
+ Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L309)
10
10
 
11
11
  KANJIDIC2 entry (kanji)
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `character` KANJIDIC2 element *(excluding some subelements)*
18
18
 
19
19
  > `optional` **isKokuji**: `true`
20
20
 
21
- Defined in: [types.ts:306](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L306)
21
+ Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L325)
22
22
 
23
23
  Whether or not the kanji is kokuji
24
24
 
@@ -28,7 +28,7 @@ Whether or not the kanji is kokuji
28
28
 
29
29
  > `readonly` **kanji**: `string`
30
30
 
31
- Defined in: [types.ts:294](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L294)
31
+ Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L313)
32
32
 
33
33
  The kanji character
34
34
 
@@ -38,7 +38,7 @@ The kanji character
38
38
 
39
39
  > `optional` **misc**: [`DictKanjiMisc`](DictKanjiMisc.md)
40
40
 
41
- Defined in: [types.ts:298](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L298)
41
+ Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L317)
42
42
 
43
43
  The miscellaneous information about the kanji
44
44
 
@@ -48,6 +48,6 @@ The miscellaneous information about the kanji
48
48
 
49
49
  > `optional` **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
50
50
 
51
- Defined in: [types.ts:302](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L302)
51
+ Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L321)
52
52
 
53
53
  The "readings-meanings" groups and nanori readings of the kanji
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiForm
8
8
 
9
- Defined in: [types.ts:57](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L57)
9
+ Defined in: [types.ts:62](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L62)
10
10
 
11
11
  Word kanji form information
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `k_ele` JMdict element
18
18
 
19
19
  > `optional` **commonness**: `string`[]
20
20
 
21
- Defined in: [types.ts:73](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L73)
21
+ Defined in: [types.ts:78](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L78)
22
22
 
23
23
  Priority codes
24
24
 
@@ -32,7 +32,7 @@ Priority codes
32
32
 
33
33
  > `readonly` **form**: `string`
34
34
 
35
- Defined in: [types.ts:61](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L61)
35
+ Defined in: [types.ts:66](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L66)
36
36
 
37
37
  The kanji form of the word
38
38
 
@@ -42,7 +42,7 @@ The kanji form of the word
42
42
 
43
43
  > `optional` **notes**: `string`[]
44
44
 
45
- Defined in: [types.ts:67](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L67)
45
+ Defined in: [types.ts:72](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L72)
46
46
 
47
47
  Other information about the kanji form
48
48
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiMisc
8
8
 
9
- Defined in: [types.ts:212](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L212)
9
+ Defined in: [types.ts:231](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L231)
10
10
 
11
11
  Miscellaneous information about the kanji
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `misc` KANJIDIC2 element *(excluding some subelements)*
18
18
 
19
19
  > `optional` **frequency**: `string`
20
20
 
21
- Defined in: [types.ts:232](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L232)
21
+ Defined in: [types.ts:251](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L251)
22
22
 
23
23
  The frequency-of-use ranking
24
24
 
@@ -30,7 +30,7 @@ A number from `1` to `2500`
30
30
 
31
31
  > `optional` **grade**: `string`
32
32
 
33
- Defined in: [types.ts:226](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L226)
33
+ Defined in: [types.ts:245](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L245)
34
34
 
35
35
  The kanji grade level
36
36
 
@@ -46,7 +46,7 @@ The kanji grade level
46
46
 
47
47
  > `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
48
48
 
49
- Defined in: [types.ts:236](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L236)
49
+ Defined in: [types.ts:255](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L255)
50
50
 
51
51
  The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Previous_format_(1984%E2%80%932009)) level
52
52
 
@@ -56,6 +56,6 @@ The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_
56
56
 
57
57
  > `optional` **strokeNumber**: `string`
58
58
 
59
- Defined in: [types.ts:216](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L216)
59
+ Defined in: [types.ts:235](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L235)
60
60
 
61
61
  The stroke count of the kanji, including the radical
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiReading
8
8
 
9
- Defined in: [types.ts:242](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L242)
9
+ Defined in: [types.ts:261](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L261)
10
10
 
11
11
  Kanji reading information
12
12
 
@@ -16,7 +16,7 @@ Kanji reading information
16
16
 
17
17
  > `readonly` **reading**: `string`
18
18
 
19
- Defined in: [types.ts:246](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L246)
19
+ Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L265)
20
20
 
21
21
  The kanji reading (hiragana or katakana)
22
22
 
@@ -26,6 +26,6 @@ The kanji reading (hiragana or katakana)
26
26
 
27
27
  > **type**: `"ja_on"` \| `"ja_kun"`
28
28
 
29
- Defined in: [types.ts:250](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L250)
29
+ Defined in: [types.ts:269](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L269)
30
30
 
31
31
  The type of reading (onyomi or kunyomi)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiReadingMeaning
8
8
 
9
- Defined in: [types.ts:274](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L274)
9
+ Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L293)
10
10
 
11
11
  Kanji "readings-meanings" groups and nanori readings
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `reading_meaning` KANJIDIC2 element
18
18
 
19
19
  > `optional` **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
20
20
 
21
- Defined in: [types.ts:278](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L278)
21
+ Defined in: [types.ts:297](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L297)
22
22
 
23
23
  The Kanji "readings-meanings" pairs
24
24
 
@@ -28,6 +28,6 @@ The Kanji "readings-meanings" pairs
28
28
 
29
29
  > `optional` **nanori**: `string`[]
30
30
 
31
- Defined in: [types.ts:282](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L282)
31
+ Defined in: [types.ts:301](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L301)
32
32
 
33
33
  The kanji nanori readings
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiReadingMeaningGroup
8
8
 
9
- Defined in: [types.ts:258](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L258)
9
+ Defined in: [types.ts:277](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L277)
10
10
 
11
11
  Kanji "readings-meanings" pair
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `rmgroup` KANJIDIC2 element
18
18
 
19
19
  > `optional` **meanings**: `string`[]
20
20
 
21
- Defined in: [types.ts:266](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L266)
21
+ Defined in: [types.ts:285](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L285)
22
22
 
23
23
  The kanji meanings
24
24
 
@@ -28,6 +28,6 @@ The kanji meanings
28
28
 
29
29
  > `optional` **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
30
30
 
31
- Defined in: [types.ts:262](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L262)
31
+ Defined in: [types.ts:281](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L281)
32
32
 
33
33
  The kanji readings
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiWithRadicals
8
8
 
9
- Defined in: [types.ts:330](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L330)
9
+ Defined in: [types.ts:349](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L349)
10
10
 
11
11
  KRADFILE2 entry (kanji with its radicals/components)
12
12
 
@@ -16,7 +16,7 @@ KRADFILE2 entry (kanji with its radicals/components)
16
16
 
17
17
  > `readonly` **kanji**: `string`
18
18
 
19
- Defined in: [types.ts:334](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L334)
19
+ Defined in: [types.ts:353](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L353)
20
20
 
21
21
  The kanji character
22
22
 
@@ -26,7 +26,7 @@ The kanji character
26
26
 
27
27
  > **radicals**: [`DictKanji`](DictKanji.md)[]
28
28
 
29
- Defined in: [types.ts:340](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L340)
29
+ Defined in: [types.ts:359](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L359)
30
30
 
31
31
  The radicals/components that make up the kanji
32
32
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictMeaning
8
8
 
9
- Defined in: [types.ts:116](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L116)
9
+ Defined in: [types.ts:135](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L135)
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:142](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L142)
21
+ Defined in: [types.ts:161](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L161)
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:164](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L164)
31
+ Defined in: [types.ts:183](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L183)
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:148](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L148)
45
+ Defined in: [types.ts:167](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L167)
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:152](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L152)
59
+ Defined in: [types.ts:171](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L171)
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:134](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L134)
69
+ Defined in: [types.ts:153](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L153)
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:158](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L158)
79
+ Defined in: [types.ts:177](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L177)
80
80
 
81
81
  Other relevant information about the meaning
82
82
 
@@ -86,11 +86,11 @@ Other relevant information about the meaning
86
86
 
87
87
  ***
88
88
 
89
- ### partOfSpeech?
89
+ ### partOfSpeech
90
90
 
91
- > `optional` **partOfSpeech**: `string`[]
91
+ > **partOfSpeech**: `string`[]
92
92
 
93
- Defined in: [types.ts:122](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L122)
93
+ Defined in: [types.ts:141](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L141)
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:138](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L138)
107
+ Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L157)
108
108
 
109
109
  Readings the meaning is restricted to
110
110
 
@@ -114,16 +114,16 @@ Readings the meaning is restricted to
114
114
 
115
115
  > `optional` **references**: `string`[]
116
116
 
117
- Defined in: [types.ts:130](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L130)
117
+ Defined in: [types.ts:149](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L149)
118
118
 
119
119
  Cross-references to other similar/related words *(when used with this meaning)*
120
120
 
121
121
  ***
122
122
 
123
- ### translations?
123
+ ### translations
124
124
 
125
- > `optional` **translations**: [`DictTranslation`](../type-aliases/DictTranslation.md)[]
125
+ > **translations**: [`DictTranslation`](../type-aliases/DictTranslation.md)[]
126
126
 
127
- Defined in: [types.ts:126](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L126)
127
+ Defined in: [types.ts:145](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L145)
128
128
 
129
129
  Word glosses
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictRadical
8
8
 
9
- Defined in: [types.ts:312](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L312)
9
+ Defined in: [types.ts:331](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L331)
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:324](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L324)
19
+ Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L343)
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:316](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L316)
29
+ Defined in: [types.ts:335](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L335)
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:320](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L320)
39
+ Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L339)
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:81](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L81)
9
+ Defined in: [types.ts:86](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L86)
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:97](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L97)
21
+ Defined in: [types.ts:102](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L102)
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:101](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L101)
35
+ Defined in: [types.ts:106](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L106)
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:91](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L91)
45
+ Defined in: [types.ts:96](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L96)
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:85](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L85)
59
+ Defined in: [types.ts:90](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L90)
60
60
 
61
61
  The reading of the word