henkan 0.9.3 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/CONTRIBUTING.md +0 -0
  2. package/LICENSE.md +0 -0
  3. package/README.md +1 -1
  4. package/SECURITY.md +0 -0
  5. package/dist/index.cjs.js +358 -53
  6. package/dist/index.cjs.js.map +2 -2
  7. package/dist/index.mjs +353 -53
  8. package/dist/index.mjs.map +2 -2
  9. package/dist/types/types.d.ts +45 -7
  10. package/dist/types/types.d.ts.map +1 -1
  11. package/dist/types/utils.d.ts +32 -11
  12. package/dist/types/utils.d.ts.map +1 -1
  13. package/docs/api/README.md +5 -0
  14. package/docs/api/functions/capitalizeString.md +1 -1
  15. package/docs/api/functions/convertJMdict.md +1 -1
  16. package/docs/api/functions/convertJawiktionary.md +29 -0
  17. package/docs/api/functions/convertKanjiDic.md +1 -1
  18. package/docs/api/functions/convertKradFile.md +1 -1
  19. package/docs/api/functions/convertRadkFile.md +1 -1
  20. package/docs/api/functions/convertTanakaCorpus.md +2 -2
  21. package/docs/api/functions/generateAnkiNote.md +1 -1
  22. package/docs/api/functions/generateAnkiNotesFile.md +4 -4
  23. package/docs/api/functions/getKanji.md +12 -6
  24. package/docs/api/functions/getKanjiExtended.md +17 -11
  25. package/docs/api/functions/getWord.md +8 -2
  26. package/docs/api/functions/getWordDefinitions.md +45 -0
  27. package/docs/api/functions/isStringArray.md +1 -1
  28. package/docs/api/functions/isValidArray.md +1 -1
  29. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  30. package/docs/api/functions/shuffleArray.md +1 -1
  31. package/docs/api/functions/synthesizeSpeech.md +1 -1
  32. package/docs/api/interfaces/Definition.md +41 -0
  33. package/docs/api/interfaces/DictKanji.md +7 -7
  34. package/docs/api/interfaces/DictKanjiForm.md +4 -4
  35. package/docs/api/interfaces/DictKanjiMisc.md +5 -5
  36. package/docs/api/interfaces/DictKanjiReading.md +3 -3
  37. package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
  38. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
  39. package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
  40. package/docs/api/interfaces/DictMeaning.md +12 -12
  41. package/docs/api/interfaces/DictRadical.md +4 -4
  42. package/docs/api/interfaces/DictReading.md +5 -5
  43. package/docs/api/interfaces/DictWord.md +8 -8
  44. package/docs/api/interfaces/ExamplePart.md +7 -7
  45. package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
  46. package/docs/api/interfaces/Grammar.md +15 -15
  47. package/docs/api/interfaces/GrammarMeaning.md +3 -3
  48. package/docs/api/interfaces/Kana.md +11 -11
  49. package/docs/api/interfaces/Kanji.md +22 -22
  50. package/docs/api/interfaces/KanjiComponent.md +3 -3
  51. package/docs/api/interfaces/KanjiForm.md +4 -4
  52. package/docs/api/interfaces/NoteAndTag.md +3 -3
  53. package/docs/api/interfaces/Phrase.md +5 -5
  54. package/docs/api/interfaces/Radical.md +16 -16
  55. package/docs/api/interfaces/Reading.md +5 -5
  56. package/docs/api/interfaces/ResultEntry.md +7 -7
  57. package/docs/api/interfaces/TanakaExample.md +7 -7
  58. package/docs/api/interfaces/Translation.md +3 -3
  59. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  60. package/docs/api/interfaces/Word.md +24 -14
  61. package/docs/api/interfaces/WordDefinitionPair.md +31 -0
  62. package/docs/api/type-aliases/Dict.md +3 -3
  63. package/docs/api/type-aliases/DictName.md +1 -1
  64. package/docs/api/type-aliases/DictTranslation.md +13 -0
  65. package/docs/api/type-aliases/EntryType.md +1 -1
  66. package/docs/api/type-aliases/JLPT.md +1 -1
  67. package/docs/api/type-aliases/Result.md +1 -1
  68. package/package.json +17 -10
@@ -0,0 +1,41 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / Definition
6
+
7
+ # Interface: Definition
8
+
9
+ Defined in: [types.ts:383](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L383)
10
+
11
+ A word definition
12
+
13
+ ## Properties
14
+
15
+ ### definition
16
+
17
+ > **definition**: `string`
18
+
19
+ Defined in: [types.ts:387](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L387)
20
+
21
+ The definition
22
+
23
+ ***
24
+
25
+ ### furigana?
26
+
27
+ > `optional` **furigana**: `string`
28
+
29
+ Defined in: [types.ts:391](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L391)
30
+
31
+ The definition with furigana attached
32
+
33
+ ***
34
+
35
+ ### mayNotBeAccurate?
36
+
37
+ > `optional` **mayNotBeAccurate**: `true`
38
+
39
+ Defined in: [types.ts:395](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L395)
40
+
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:243](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L243)
9
+ Defined in: [types.ts:249](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L249)
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:259](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L259)
21
+ Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L265)
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:247](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L247)
31
+ Defined in: [types.ts:253](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L253)
32
32
 
33
33
  The kanji character
34
34
 
@@ -38,16 +38,16 @@ The kanji character
38
38
 
39
39
  > `optional` **misc**: [`DictKanjiMisc`](DictKanjiMisc.md)
40
40
 
41
- Defined in: [types.ts:251](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L251)
41
+ Defined in: [types.ts:257](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L257)
42
42
 
43
43
  The miscellaneous information about the kanji
44
44
 
45
45
  ***
46
46
 
47
- ### readingMeaning
47
+ ### readingMeaning?
48
48
 
49
- > **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
49
+ > `optional` **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
50
50
 
51
- Defined in: [types.ts:255](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L255)
51
+ Defined in: [types.ts:261](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L261)
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:16](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L16)
9
+ Defined in: [types.ts:16](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L16)
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:32](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L32)
21
+ Defined in: [types.ts:32](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L32)
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:20](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L20)
35
+ Defined in: [types.ts:20](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L20)
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:26](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L26)
45
+ Defined in: [types.ts:26](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L26)
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:165](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L165)
9
+ Defined in: [types.ts:171](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L171)
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:185](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L185)
21
+ Defined in: [types.ts:191](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L191)
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:179](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L179)
33
+ Defined in: [types.ts:185](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L185)
34
34
 
35
35
  The kanji grade level
36
36
 
@@ -46,7 +46,7 @@ The kanji grade level
46
46
 
47
47
  > `optional` **jlpt**: `string`
48
48
 
49
- Defined in: [types.ts:189](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L189)
49
+ Defined in: [types.ts:195](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L195)
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\_Proficien
56
56
 
57
57
  > `readonly` **strokeNumber**: `string`
58
58
 
59
- Defined in: [types.ts:169](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L169)
59
+ Defined in: [types.ts:175](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L175)
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:195](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L195)
9
+ Defined in: [types.ts:201](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L201)
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:199](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L199)
19
+ Defined in: [types.ts:205](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L205)
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:203](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L203)
29
+ Defined in: [types.ts:209](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L209)
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:227](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L227)
9
+ Defined in: [types.ts:233](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L233)
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
  > **groups**: [`DictKanjiReadingMeaningGroup`](DictKanjiReadingMeaningGroup.md)[]
20
20
 
21
- Defined in: [types.ts:231](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L231)
21
+ Defined in: [types.ts:237](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L237)
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:235](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L235)
31
+ Defined in: [types.ts:241](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L241)
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:211](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L211)
9
+ Defined in: [types.ts:217](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L217)
10
10
 
11
11
  Kanji "readings-meanings" pair
12
12
 
@@ -18,7 +18,7 @@ Equivalent to the `rmgroup` KANJIDIC2 element
18
18
 
19
19
  > **meanings**: `string`[]
20
20
 
21
- Defined in: [types.ts:219](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L219)
21
+ Defined in: [types.ts:225](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L225)
22
22
 
23
23
  The kanji meanings
24
24
 
@@ -28,6 +28,6 @@ The kanji meanings
28
28
 
29
29
  > **readings**: [`DictKanjiReading`](DictKanjiReading.md)[]
30
30
 
31
- Defined in: [types.ts:215](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L215)
31
+ Defined in: [types.ts:221](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L221)
32
32
 
33
33
  The kanji readings
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: DictKanjiWithRadicals
8
8
 
9
- Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L283)
9
+ Defined in: [types.ts:289](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L289)
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:287](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L287)
19
+ Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L293)
20
20
 
21
21
  The kanji character
22
22
 
@@ -26,7 +26,7 @@ The kanji character
26
26
 
27
27
  > **radicals**: (`string` \| [`DictKanji`](DictKanji.md))[]
28
28
 
29
- Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L293)
29
+ Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L299)
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:67](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L67)
9
+ Defined in: [types.ts:75](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:95](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L95)
21
+ Defined in: [types.ts:101](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:117](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L117)
31
+ Defined in: [types.ts:123](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:101](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L101)
45
+ Defined in: [types.ts:107](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:105](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L105)
59
+ Defined in: [types.ts:111](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:87](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L87)
69
+ Defined in: [types.ts:93](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:111](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L111)
79
+ Defined in: [types.ts:117](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:73](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L73)
93
+ Defined in: [types.ts:81](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:91](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L91)
107
+ Defined in: [types.ts:97](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:83](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L83)
117
+ Defined in: [types.ts:89](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L89)
118
118
 
119
119
  Cross-references to other similar/related words *(when used with this meaning)*
120
120
 
@@ -122,8 +122,8 @@ Cross-references to other similar/related words *(when used with this meaning)*
122
122
 
123
123
  ### translations?
124
124
 
125
- > `optional` **translations**: (`string` \| \{ `translation`: `string`; `type`: `"lit"` \| `"expl"` \| `"tm"`; \})[]
125
+ > `optional` **translations**: [`DictTranslation`](../type-aliases/DictTranslation.md)[]
126
126
 
127
- Defined in: [types.ts:77](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L77)
127
+ Defined in: [types.ts:85](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:265](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L265)
9
+ Defined in: [types.ts:271](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:277](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L277)
19
+ Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:269](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L269)
29
+ Defined in: [types.ts:275](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:273](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L273)
39
+ Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L40)
9
+ Defined in: [types.ts:40](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L56)
21
+ Defined in: [types.ts:56](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L60)
35
+ Defined in: [types.ts:60](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L50)
45
+ Defined in: [types.ts:50](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L44)
59
+ Defined in: [types.ts:44](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:125](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L125)
9
+ Defined in: [types.ts:131](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:157](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L157)
21
+ Defined in: [types.ts:163](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:129](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L129)
33
+ Defined in: [types.ts:135](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:145](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L145)
43
+ Defined in: [types.ts:151](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:133](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L133)
53
+ Defined in: [types.ts:139](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:141](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L141)
63
+ Defined in: [types.ts:147](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:137](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L137)
73
+ Defined in: [types.ts:143](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:151](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L151)
83
+ Defined in: [types.ts:157](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:299](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L299)
9
+ Defined in: [types.ts:305](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:303](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L303)
19
+ Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:327](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L327)
29
+ Defined in: [types.ts:333](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:311](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L311)
43
+ Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:315](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L315)
53
+ Defined in: [types.ts:321](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:307](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L307)
63
+ Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:319](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L319)
73
+ Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:333](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L333)
9
+ Defined in: [types.ts:339](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:341](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L341)
19
+ Defined in: [types.ts:347](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/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:337](https://github.com/Ronokof/Henkan/blob/023926521f50f475b03a207d5b9f30d7c4f14c62/src/types.ts#L337)
29
+ Defined in: [types.ts:343](https://github.com/Ronokof/Henkan/blob/e0f685c675998bfb93cbe454a3fe16d279853c5a/src/types.ts#L343)
30
30
 
31
31
  The entry ID