henkan 2.4.12 → 3.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.
- package/README.md +1 -1
- package/dist/index.cjs.js +439 -46
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +436 -46
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +106 -15
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +28 -6
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/README.md +8 -2
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +1 -1
- package/docs/api/functions/convertJMnedict.md +33 -0
- package/docs/api/functions/convertJawiktionaryAsync.md +1 -1
- package/docs/api/functions/convertJawiktionarySync.md +1 -1
- package/docs/api/functions/convertKanjiDic.md +1 -1
- package/docs/api/functions/convertKradFile.md +1 -1
- package/docs/api/functions/convertRadkFile.md +1 -1
- package/docs/api/functions/convertTanakaCorpus.md +1 -1
- package/docs/api/functions/convertTanakaCorpusWithFurigana.md +1 -1
- package/docs/api/functions/createEntryMaps.md +9 -3
- package/docs/api/functions/generateAnkiNote.md +2 -2
- package/docs/api/functions/generateAnkiNotesFile.md +1 -1
- package/docs/api/functions/generateFurigana.md +1 -1
- package/docs/api/functions/getKanji.md +1 -1
- package/docs/api/functions/getKanjiExtended.md +1 -1
- package/docs/api/functions/getName.md +57 -0
- package/docs/api/functions/getValidForms.md +1 -1
- package/docs/api/functions/getWord.md +3 -3
- package/docs/api/functions/getWordDefinitions.md +1 -1
- package/docs/api/functions/getWordDefinitionsWithFurigana.md +1 -1
- package/docs/api/functions/hiraganaToKatakana.md +1 -1
- package/docs/api/functions/isObjectArray.md +1 -1
- package/docs/api/functions/isStringArray.md +1 -1
- package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
- package/docs/api/functions/katakanaToHiragana.md +1 -1
- package/docs/api/functions/shuffleArray.md +1 -1
- package/docs/api/interfaces/DefaultNoteInfo.md +10 -10
- package/docs/api/interfaces/Definition.md +4 -4
- package/docs/api/interfaces/DictKanji.md +5 -5
- package/docs/api/interfaces/DictKanjiForm.md +2 -2
- package/docs/api/interfaces/DictKanjiMisc.md +5 -5
- package/docs/api/interfaces/DictKanjiReading.md +3 -3
- package/docs/api/interfaces/DictKanjiReadingMeaning.md +3 -3
- package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +3 -3
- package/docs/api/interfaces/DictKanjiWithRadicals.md +3 -3
- package/docs/api/interfaces/DictName.md +75 -0
- package/docs/api/interfaces/DictRadical.md +4 -4
- package/docs/api/interfaces/DictReading.md +2 -2
- package/docs/api/interfaces/EntryMaps.md +33 -9
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
- package/docs/api/interfaces/Grammar.md +15 -15
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/JaWiktionaryEntry.md +5 -5
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +23 -23
- package/docs/api/interfaces/KanjiComponent.md +3 -3
- package/docs/api/interfaces/KanjiForm.md +5 -5
- package/docs/api/interfaces/Name.md +163 -0
- package/docs/api/interfaces/NeDictMeaning.md +33 -0
- package/docs/api/interfaces/NoteAndTag.md +3 -3
- package/docs/api/interfaces/NoteHeaderKeys.md +7 -7
- package/docs/api/interfaces/Phrase.md +5 -5
- package/docs/api/interfaces/Radical.md +16 -16
- package/docs/api/interfaces/Reading.md +6 -6
- package/docs/api/interfaces/ResultEntry.md +8 -7
- package/docs/api/interfaces/TanakaExample.md +7 -7
- package/docs/api/interfaces/Translation.md +5 -5
- package/docs/api/interfaces/UsefulRegExps.md +8 -8
- package/docs/api/interfaces/Word.md +15 -15
- package/docs/api/interfaces/WordDefinitionPair.md +4 -4
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/{DictName.md → DictNames.md} +3 -3
- package/docs/api/type-aliases/EntryExamplesMap.md +13 -0
- package/docs/api/type-aliases/EntryType.md +2 -2
- package/docs/api/type-aliases/KanjiEntryMap.md +1 -1
- package/docs/api/type-aliases/KanjiSVGMap.md +1 -1
- package/docs/api/type-aliases/KanjiWordsMap.md +1 -1
- package/docs/api/type-aliases/NameIDEntryMap.md +13 -0
- package/docs/api/type-aliases/Result.md +2 -2
- package/docs/api/type-aliases/WordDefinitionsMap.md +1 -1
- package/docs/api/type-aliases/WordIDEntryMap.md +1 -1
- package/package.json +8 -7
- package/src/types.ts +115 -15
- package/src/utils.ts +733 -162
- package/docs/api/type-aliases/WordExamplesMap.md +0 -13
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getKanjiExtended**(`info`, `kanji`, `dict?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`, `sourceURL?`): [`Kanji`](../interfaces/Kanji.md) \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2186](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2186)
|
|
12
12
|
|
|
13
13
|
Same as [getKanji](getKanji.md), but with possible extra info.
|
|
14
14
|
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[**henkan**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[henkan](../README.md) / getName
|
|
6
|
+
|
|
7
|
+
# Function: getName()
|
|
8
|
+
|
|
9
|
+
> **getName**(`searchedName`, `dict?`, `kanjiDic?`, `examples?`, `noteTypeName?`, `deckPath?`): [`Name`](../interfaces/Name.md) \| `undefined`
|
|
10
|
+
|
|
11
|
+
Defined in: [utils.ts:2725](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2725)
|
|
12
|
+
|
|
13
|
+
Transforms a converted `JMnedict` entry into a more readable format, by providing either its JMnedict entry ID or the [DictName](../interfaces/DictName.md) object directly.
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### searchedName
|
|
18
|
+
|
|
19
|
+
The ID of the `JMnedict` entry (requires [dict](#getname)) or a [DictName](../interfaces/DictName.md) object
|
|
20
|
+
|
|
21
|
+
`` `${number}` `` | [`DictName`](../interfaces/DictName.md)
|
|
22
|
+
|
|
23
|
+
### dict?
|
|
24
|
+
|
|
25
|
+
An array converted `JMnedict` entries or a [NameIDEntryMap](../type-aliases/NameIDEntryMap.md) *(not needed if [searchedName](#getname) is a [DictName](../interfaces/DictName.md) object)*
|
|
26
|
+
|
|
27
|
+
[`NameIDEntryMap`](../type-aliases/NameIDEntryMap.md) | readonly [`DictName`](../interfaces/DictName.md)[]
|
|
28
|
+
|
|
29
|
+
### kanjiDic?
|
|
30
|
+
|
|
31
|
+
An array of converted `KANJIDIC` entries or a [KanjiEntryMap](../type-aliases/KanjiEntryMap.md)
|
|
32
|
+
|
|
33
|
+
[`KanjiEntryMap`](../type-aliases/KanjiEntryMap.md) | readonly [`DictKanji`](../interfaces/DictKanji.md)[]
|
|
34
|
+
|
|
35
|
+
### examples?
|
|
36
|
+
|
|
37
|
+
An array of converted `Tanaka Corpus` examples or a [EntryExamplesMap](../type-aliases/EntryExamplesMap.md)
|
|
38
|
+
|
|
39
|
+
[`EntryExamplesMap`](../type-aliases/EntryExamplesMap.md) | readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]
|
|
40
|
+
|
|
41
|
+
### noteTypeName?
|
|
42
|
+
|
|
43
|
+
`string`
|
|
44
|
+
|
|
45
|
+
The Anki note type name
|
|
46
|
+
|
|
47
|
+
### deckPath?
|
|
48
|
+
|
|
49
|
+
`string`
|
|
50
|
+
|
|
51
|
+
The full Anki deck path
|
|
52
|
+
|
|
53
|
+
## Returns
|
|
54
|
+
|
|
55
|
+
[`Name`](../interfaces/Name.md) \| `undefined`
|
|
56
|
+
|
|
57
|
+
The transformed [DictName](../interfaces/DictName.md) object or `undefined` if entry is not found
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getValidForms**(`readings`, `kanjiForms?`, `wordIsCommon?`): [`ReadingsKanjiFormsPair`](../interfaces/ReadingsKanjiFormsPair.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:214](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L214)
|
|
12
12
|
|
|
13
13
|
Filters out all the old/rare or (if [wordIsCommon](#getvalidforms) is `true`) uncommon readings and kanji forms of a JMdict entry.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getWord**(`searchedWord`, `dict?`, `kanjiDic?`, `examples?`, `definitions?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md) \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2257](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2257)
|
|
12
12
|
|
|
13
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.
|
|
14
14
|
|
|
@@ -34,9 +34,9 @@ An array of converted `KANJIDIC` entries or a [KanjiEntryMap](../type-aliases/Ka
|
|
|
34
34
|
|
|
35
35
|
### examples?
|
|
36
36
|
|
|
37
|
-
An array of converted `Tanaka Corpus` examples or a [
|
|
37
|
+
An array of converted `Tanaka Corpus` examples or a [EntryExamplesMap](../type-aliases/EntryExamplesMap.md)
|
|
38
38
|
|
|
39
|
-
[`
|
|
39
|
+
[`EntryExamplesMap`](../type-aliases/EntryExamplesMap.md) | readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]
|
|
40
40
|
|
|
41
41
|
### definitions?
|
|
42
42
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getWordDefinitions**(`wiktionaryEntries`, `jmDict`): [`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1323](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1323)
|
|
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:
|
|
11
|
+
Defined in: [utils.ts:1914](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1914)
|
|
12
12
|
|
|
13
13
|
Pairs Japanese definitions with JMdict word entries (with furigana)
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **hiraganaToKatakana**(`input`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:127](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L127)
|
|
12
12
|
|
|
13
13
|
Convert hiragana text to katakana text
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isObjectArray**(`arg`): `arg is any[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:97](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L97)
|
|
12
12
|
|
|
13
13
|
Checks if the argument is an array of object.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isStringArray**(`arg`): `arg is string[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:85](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L85)
|
|
12
12
|
|
|
13
13
|
Checks if the argument is an array of strings.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:76](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L76)
|
|
12
12
|
|
|
13
13
|
Checks if the argument is an array and has at least one element.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **katakanaToHiragana**(`input`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:152](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L152)
|
|
12
12
|
|
|
13
13
|
Convert katakana text to hiragana text
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **shuffleArray**\<`T`\>(`arr`): `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:109](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L109)
|
|
12
12
|
|
|
13
13
|
Shuffles an array using the `Fisher–Yates shuffle` algorithm
|
|
14
14
|
|
|
@@ -6,17 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DefaultNoteInfo
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:1073](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1073)
|
|
10
10
|
|
|
11
11
|
Default note ID, note type and deck name of a note
|
|
12
12
|
|
|
13
13
|
Setting any of the properties to:
|
|
14
14
|
|
|
15
|
-
- a `string` will make that string the default note ID/note type/deck name of the note in case [Result.noteID](
|
|
15
|
+
- a `string` will make that string the default note ID/note type/deck name of the note in case [Result.noteID](Kana.md#noteid)/[Result.noteTypeName](Kana.md#notetypename)/[Result.deckPath](Kana.md#deckpath) is `undefined`.
|
|
16
16
|
|
|
17
|
-
- `true` will require all [Result](../type-aliases/Result.md) objects to have [Result.noteID](
|
|
17
|
+
- `true` will require all [Result](../type-aliases/Result.md) objects to have [Result.noteID](Kana.md#noteid)/[Result.noteTypeName](Kana.md#notetypename)/[Result.deckPath](Kana.md#deckpath) set (*no default values*).
|
|
18
18
|
|
|
19
|
-
- `undefined` (*or not set*) will require all [Result](../type-aliases/Result.md) objects to either have [Result.noteID](
|
|
19
|
+
- `undefined` (*or not set*) will require all [Result](../type-aliases/Result.md) objects to either have [Result.noteID](Kana.md#noteid)/[Result.noteTypeName](Kana.md#notetypename)/[Result.deckPath](Kana.md#deckpath) set or not set (*no default values*).
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
@@ -24,9 +24,9 @@ Setting any of the properties to:
|
|
|
24
24
|
|
|
25
25
|
> `optional` **deckPath**: `string` \| `true`
|
|
26
26
|
|
|
27
|
-
Defined in: [types.ts:
|
|
27
|
+
Defined in: [types.ts:1087](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1087)
|
|
28
28
|
|
|
29
|
-
A default for [Result.deckPath](
|
|
29
|
+
A default for [Result.deckPath](Kana.md#deckpath)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,9 +34,9 @@ A default for [Result.deckPath](Grammar.md#deckpath)
|
|
|
34
34
|
|
|
35
35
|
> `optional` **guid**: `true` \| `"main_information"`
|
|
36
36
|
|
|
37
|
-
Defined in: [types.ts:
|
|
37
|
+
Defined in: [types.ts:1079](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1079)
|
|
38
38
|
|
|
39
|
-
A default for [Result.noteID](
|
|
39
|
+
A default for [Result.noteID](Kana.md#noteid)
|
|
40
40
|
|
|
41
41
|
`main_information` will make either the ID or kana/kanji/radical character the default note ID of the note.
|
|
42
42
|
|
|
@@ -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:
|
|
49
|
+
Defined in: [types.ts:1083](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L1083)
|
|
50
50
|
|
|
51
|
-
A default for [Result.noteTypeName](
|
|
51
|
+
A default for [Result.noteTypeName](Kana.md#notetypename)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Definition
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:593](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L593)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:597](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L597)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:601](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L601)
|
|
30
30
|
|
|
31
31
|
The definition with furigana attached
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The definition with furigana attached
|
|
|
36
36
|
|
|
37
37
|
> `optional` **mayNotBeAccurate**: `1` \| `2`
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:
|
|
39
|
+
Defined in: [types.ts:609](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L609)
|
|
40
40
|
|
|
41
41
|
Whether or not the definition is associated with other words
|
|
42
42
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictKanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:357](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L357)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:373](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L373)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:361](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L361)
|
|
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:
|
|
41
|
+
Defined in: [types.ts:365](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L365)
|
|
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:
|
|
51
|
+
Defined in: [types.ts:369](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L369)
|
|
52
52
|
|
|
53
53
|
The "readings-meanings" groups and nanori readings of the kanji
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
Defined in: [types.ts:62](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L62)
|
|
10
10
|
|
|
11
|
-
Word kanji form information
|
|
11
|
+
Word/Name kanji form information
|
|
12
12
|
|
|
13
|
-
Equivalent to the `k_ele` JMdict element
|
|
13
|
+
Equivalent to the `k_ele` JMdict/JMnedict element
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictKanjiMisc
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:279](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L279)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L299)
|
|
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:
|
|
33
|
+
Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L293)
|
|
34
34
|
|
|
35
35
|
The kanji grade level
|
|
36
36
|
|
|
@@ -46,7 +46,7 @@ The kanji grade level
|
|
|
46
46
|
|
|
47
47
|
> `optional` **jlpt**: `` `N${number}` ``
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:
|
|
49
|
+
Defined in: [types.ts:303](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L303)
|
|
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:
|
|
59
|
+
Defined in: [types.ts:283](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L283)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:309](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L309)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:313](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L313)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:317](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L317)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:341](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L341)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:345](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L345)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:349](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L349)
|
|
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:
|
|
9
|
+
Defined in: [types.ts:325](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L325)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:333](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L333)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:329](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L329)
|
|
32
32
|
|
|
33
33
|
The kanji readings
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictKanjiWithRadicals
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:397](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L397)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:401](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L401)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:407](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L407)
|
|
30
30
|
|
|
31
31
|
The radicals/components that make up the kanji
|
|
32
32
|
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
[**henkan**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[henkan](../README.md) / DictName
|
|
6
|
+
|
|
7
|
+
# Interface: DictName
|
|
8
|
+
|
|
9
|
+
Defined in: [types.ts:245](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L245)
|
|
10
|
+
|
|
11
|
+
JMnedict entry (name)
|
|
12
|
+
|
|
13
|
+
Equivalent to the `entry` JMnedict element
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### hasPhrases?
|
|
18
|
+
|
|
19
|
+
> `optional` **hasPhrases**: `true`
|
|
20
|
+
|
|
21
|
+
Defined in: [types.ts:271](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L271)
|
|
22
|
+
|
|
23
|
+
Whether or not the entry has at least one Tanaka Corpus phrase associated with it
|
|
24
|
+
|
|
25
|
+
**May not always be accurate**
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### id
|
|
30
|
+
|
|
31
|
+
> `readonly` **id**: `` `${number}` ``
|
|
32
|
+
|
|
33
|
+
Defined in: [types.ts:249](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L249)
|
|
34
|
+
|
|
35
|
+
The entry sequence number
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
39
|
+
### isCommon?
|
|
40
|
+
|
|
41
|
+
> `optional` **isCommon**: `true`
|
|
42
|
+
|
|
43
|
+
Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L265)
|
|
44
|
+
|
|
45
|
+
Whether or not the entry has a priority tag (`k_pri` or `r_pri`)
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### kanjiForms?
|
|
50
|
+
|
|
51
|
+
> `optional` **kanjiForms**: [`DictKanjiForm`](DictKanjiForm.md)[]
|
|
52
|
+
|
|
53
|
+
Defined in: [types.ts:261](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L261)
|
|
54
|
+
|
|
55
|
+
The name's kanji forms
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### meanings
|
|
60
|
+
|
|
61
|
+
> **meanings**: [`NeDictMeaning`](NeDictMeaning.md)[]
|
|
62
|
+
|
|
63
|
+
Defined in: [types.ts:257](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L257)
|
|
64
|
+
|
|
65
|
+
The name's meanings/senses
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### nameReadings
|
|
70
|
+
|
|
71
|
+
> **nameReadings**: [`DictReading`](DictReading.md)[]
|
|
72
|
+
|
|
73
|
+
Defined in: [types.ts:253](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L253)
|
|
74
|
+
|
|
75
|
+
The name's readings
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictRadical
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:379](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L379)
|
|
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:
|
|
19
|
+
Defined in: [types.ts:391](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L391)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:383](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L383)
|
|
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:
|
|
39
|
+
Defined in: [types.ts:387](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L387)
|
|
40
40
|
|
|
41
41
|
The stroke count of the radical
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
Defined in: [types.ts:86](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L86)
|
|
10
10
|
|
|
11
|
-
Word reading information
|
|
11
|
+
Word/Name reading information
|
|
12
12
|
|
|
13
|
-
Equivalent to the `r_ele` JMdict element
|
|
13
|
+
Equivalent to the `r_ele` JMdict/JMnedict element
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|