henkan 0.3.3 → 0.4.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.
- package/dist/index.cjs.js +97 -124
- package/dist/index.cjs.js.map +3 -3
- package/dist/index.mjs +95 -120
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +16 -12
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +6 -6
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +1 -1
- package/docs/api/functions/convertKanjiDic.md +1 -1
- package/docs/api/functions/convertKradFile.md +4 -4
- package/docs/api/functions/convertRadkFile.md +4 -4
- package/docs/api/functions/convertTanakaCorpus.md +1 -1
- package/docs/api/functions/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +1 -1
- package/docs/api/functions/getKanji.md +1 -1
- package/docs/api/functions/getKanjiExtended.md +1 -1
- package/docs/api/functions/getWord.md +1 -1
- package/docs/api/functions/isStringArray.md +1 -1
- package/docs/api/functions/isValidArray.md +1 -1
- package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
- package/docs/api/functions/makeSSML.md +1 -1
- package/docs/api/functions/shuffleArray.md +1 -1
- package/docs/api/functions/synthesizeSpeech.md +1 -1
- package/docs/api/interfaces/DictKanji.md +5 -5
- package/docs/api/interfaces/DictKanjiForm.md +4 -4
- 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/DictMeaning.md +11 -11
- package/docs/api/interfaces/DictRadical.md +4 -4
- package/docs/api/interfaces/DictReading.md +5 -5
- package/docs/api/interfaces/DictWord.md +29 -19
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/Grammar.md +15 -15
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +22 -22
- package/docs/api/interfaces/KanjiComponent.md +3 -3
- package/docs/api/interfaces/KanjiForm.md +4 -4
- package/docs/api/interfaces/NoteAndTag.md +3 -3
- package/docs/api/interfaces/Phrase.md +4 -4
- package/docs/api/interfaces/Radical.md +16 -16
- package/docs/api/interfaces/Reading.md +5 -5
- package/docs/api/interfaces/ResultEntry.md +7 -7
- package/docs/api/interfaces/TanakaExample.md +17 -7
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +9 -9
- package/docs/api/interfaces/Word.md +18 -18
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/DictName.md +1 -1
- package/docs/api/type-aliases/EntryType.md +1 -1
- package/docs/api/type-aliases/JLPT.md +1 -1
- package/docs/api/type-aliases/Result.md +1 -1
- package/package.json +6 -6
package/dist/types/types.d.ts
CHANGED
|
@@ -117,7 +117,7 @@ export interface DictMeaning {
|
|
|
117
117
|
/**
|
|
118
118
|
* JMdict entry (word)
|
|
119
119
|
*
|
|
120
|
-
* Equivalent to the `entry` JMdict element
|
|
120
|
+
* Equivalent to the `entry` JMdict element + miscellaneous info
|
|
121
121
|
*/
|
|
122
122
|
export interface DictWord {
|
|
123
123
|
/**
|
|
@@ -141,11 +141,15 @@ export interface DictWord {
|
|
|
141
141
|
*/
|
|
142
142
|
isCommon?: true | undefined;
|
|
143
143
|
/**
|
|
144
|
-
* Whether or not the
|
|
144
|
+
* Whether or not the word is typically written in kana alone
|
|
145
145
|
*
|
|
146
|
-
*
|
|
146
|
+
* Set to `true` only if the word is usually written in kana for all word senses.
|
|
147
|
+
*/
|
|
148
|
+
usuallyInKana?: true | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* IDs of Tanaka Corpus phrases associated with the entry
|
|
147
151
|
*/
|
|
148
|
-
|
|
152
|
+
phraseIDs?: `${number}_${number}`[] | undefined;
|
|
149
153
|
}
|
|
150
154
|
/**
|
|
151
155
|
* Miscellaneous information about the kanji
|
|
@@ -313,6 +317,10 @@ export interface ExamplePart {
|
|
|
313
317
|
* Tanaka Corpus `examples.utf` examples
|
|
314
318
|
*/
|
|
315
319
|
export interface TanakaExample {
|
|
320
|
+
/**
|
|
321
|
+
* The ID of the example
|
|
322
|
+
*/
|
|
323
|
+
readonly id: `${number}_${number}`;
|
|
316
324
|
/**
|
|
317
325
|
* The Japanese phrase (found in the `A` section, **before** the tab)
|
|
318
326
|
*/
|
|
@@ -324,11 +332,11 @@ export interface TanakaExample {
|
|
|
324
332
|
/**
|
|
325
333
|
* The `B` section, split into parts
|
|
326
334
|
*/
|
|
327
|
-
parts: ExamplePart[];
|
|
335
|
+
readonly parts: ExamplePart[];
|
|
328
336
|
/**
|
|
329
337
|
* The Japanese phrase, with furigana attached
|
|
330
338
|
*/
|
|
331
|
-
furigana?: string | undefined;
|
|
339
|
+
readonly furigana?: string | undefined;
|
|
332
340
|
}
|
|
333
341
|
/**
|
|
334
342
|
* Any type of entry list
|
|
@@ -604,15 +612,11 @@ export interface Word extends ResultEntry<"word"> {
|
|
|
604
612
|
*/
|
|
605
613
|
phrases?: Phrase[] | undefined;
|
|
606
614
|
/**
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
* A word is considered *common* if the {@link DictWord.readings} and/or the {@link DictWord.kanjiForms} array(s) include(s) at least one element with the {@link DictReading.commonness} or {@link DictKanjiForm.commonness} property defined.
|
|
615
|
+
* @see {@link DictWord.isCommon}
|
|
610
616
|
*/
|
|
611
617
|
common?: true | undefined;
|
|
612
618
|
/**
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
* Set to `true` only if the word is usually written in kana for all word senses.
|
|
619
|
+
* @see {@link DictWord.usuallyInKana}
|
|
616
620
|
*/
|
|
617
621
|
usuallyInKana?: true | undefined;
|
|
618
622
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC9C;AACD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EACT,CAAC,MAAM,GAAG;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,EAAE,GACjE,SAAS,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC9C;AACD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EACT,CAAC,MAAM,GAAG;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,EAAE,GACjE,SAAS,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,GAAG,SAAS,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,4BAA4B,EAAE,CAAC;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,cAAc,EAAE,uBAAuB,EAAE,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ,QAAQ,EAAE,GACV,SAAS,EAAE,GACX,aAAa,EAAE,GACf,WAAW,EAAE,GACb,qBAAqB,EAAE,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,SAAS,SAAS,MAAM;IACnD;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,IAAI,MAAM,EAAE,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW,CAAC,OAAO,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,CAAC,SAAS,CAAC;IACrD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW,CAAC,MAAM,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW,CAAC,MAAM,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,CAAC,SAAS,CAAC;IACrD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACpC"}
|
package/dist/types/utils.d.ts
CHANGED
|
@@ -51,20 +51,20 @@ export declare function convertKanjiDic(xmlString: string): DictKanji[];
|
|
|
51
51
|
*/
|
|
52
52
|
export declare function convertTanakaCorpus(tanakaString: string, generateFurigana?: true): Promise<TanakaExample[]>;
|
|
53
53
|
/**
|
|
54
|
-
* Converts a `
|
|
55
|
-
* @param radkBuffer A raw `
|
|
54
|
+
* Converts a `radkfile` file into an array of {@link DictRadical} objects.
|
|
55
|
+
* @param radkBuffer A raw `radkfile` buffer
|
|
56
56
|
* @param kanjiDic An array of converted `KANJIDIC` entries
|
|
57
57
|
* @returns An array of converted {@link DictRadical} objects
|
|
58
58
|
*/
|
|
59
|
-
export declare function convertRadkFile(radkBuffer:
|
|
59
|
+
export declare function convertRadkFile(radkBuffer: Buffer<ArrayBuffer>, kanjiDic: DictKanji[]): DictRadical[];
|
|
60
60
|
/**
|
|
61
|
-
* Converts a `
|
|
62
|
-
* @param kradBuffer A raw `
|
|
61
|
+
* Converts a `kradfile` file into an array of {@link DictKanjiWithRadicals} objects.
|
|
62
|
+
* @param kradBuffer A raw `kradfile` buffer
|
|
63
63
|
* @param kanjiDic An array of converted `KANJIDIC` entries
|
|
64
64
|
* @param katakanaList An array of katakana {@link Kana} objects
|
|
65
65
|
* @returns An array of converted {@link DictKanjiWithRadicals} objects
|
|
66
66
|
*/
|
|
67
|
-
export declare function convertKradFile(kradBuffer:
|
|
67
|
+
export declare function convertKradFile(kradBuffer: Buffer<ArrayBuffer>, kanjiDic: DictKanji[], katakanaList: Kana[]): DictKanjiWithRadicals[];
|
|
68
68
|
/**
|
|
69
69
|
* Transforms a converted `JMdict` entry into a more readable format, by providing either its {@link id} or the {@link dictWord} object directly.
|
|
70
70
|
* @param dict An array of converted `JMdict` entries
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,WAAW,EAEX,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,EACP,IAAI,EACJ,KAAK,EAKL,OAAO,EAEP,MAAM,EACN,aAAa,EAEb,IAAI,EACL,MAAM,SAAS,CAAC;AAKjB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAQnE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,EAAE,CAOvD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAe7C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,GACrC,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,WAAW,EAEX,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,EACP,IAAI,EACJ,KAAK,EAKL,OAAO,EAEP,MAAM,EACN,aAAa,EAEb,IAAI,EACL,MAAM,SAAS,CAAC;AAKjB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAQnE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,EAAE,CAOvD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAe7C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,GACrC,QAAQ,EAAE,CA8TZ;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,CA4H9D;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,YAAY,EAAE,MAAM,EACpB,gBAAgB,CAAC,EAAE,IAAI,GACtB,OAAO,CAAC,aAAa,EAAE,CAAC,CAqH1B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAC/B,QAAQ,EAAE,SAAS,EAAE,GACpB,WAAW,EAAE,CAyDf;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAC/B,QAAQ,EAAE,SAAS,EAAE,EACrB,YAAY,EAAE,IAAI,EAAE,GACnB,qBAAqB,EAAE,CAuEzB;AAqCD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,IAAI,CAAC,EAAE,QAAQ,EAAE,EACjB,EAAE,CAAC,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,SAAS,EAAE,EACtB,QAAQ,CAAC,EAAE,aAAa,EAAE,EAC1B,QAAQ,CAAC,EAAE,QAAQ,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAmMN;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,SAAS,EAAE,EACjB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CA0NP;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,SAAS,EAAE,EACjB,YAAY,CAAC,EAAE,IAAI,EACnB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAoDP;AAgCD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CA4EtE;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/D,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CA6BrC;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAKnD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAMzD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,KAAK,CAOrD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAInD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAKzD;AAgBD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CA6RxD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CA+BxE"}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **capitalizeString**(`value`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:53](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:53](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L53)
|
|
12
12
|
|
|
13
13
|
Capitalizes a string.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertJMdict**(`xmlString`, `examples?`): [`DictWord`](../interfaces/DictWord.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:123](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:123](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L123)
|
|
12
12
|
|
|
13
13
|
Converts a JMdict `JMdict_e.xml`/`JMdict_e` file into an array of [DictWord](../interfaces/DictWord.md) objects.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertKanjiDic**(`xmlString`): [`DictKanji`](../interfaces/DictKanji.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:451](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L451)
|
|
12
12
|
|
|
13
13
|
Converts a KANJIDIC `kanjidic2.xml` file into an array of [DictKanji](../interfaces/DictKanji.md) objects.
|
|
14
14
|
|
|
@@ -8,17 +8,17 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertKradFile**(`kradBuffer`, `kanjiDic`, `katakanaList`): [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:780](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L780)
|
|
12
12
|
|
|
13
|
-
Converts a `
|
|
13
|
+
Converts a `kradfile` file into an array of [DictKanjiWithRadicals](../interfaces/DictKanjiWithRadicals.md) objects.
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
17
|
### kradBuffer
|
|
18
18
|
|
|
19
|
-
`
|
|
19
|
+
`Buffer`\<`ArrayBuffer`\>
|
|
20
20
|
|
|
21
|
-
A raw `
|
|
21
|
+
A raw `kradfile` buffer
|
|
22
22
|
|
|
23
23
|
### kanjiDic
|
|
24
24
|
|
|
@@ -8,17 +8,17 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertRadkFile**(`radkBuffer`, `kanjiDic`): [`DictRadical`](../interfaces/DictRadical.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:711](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L711)
|
|
12
12
|
|
|
13
|
-
Converts a `
|
|
13
|
+
Converts a `radkfile` file into an array of [DictRadical](../interfaces/DictRadical.md) objects.
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
17
|
### radkBuffer
|
|
18
18
|
|
|
19
|
-
`
|
|
19
|
+
`Buffer`\<`ArrayBuffer`\>
|
|
20
20
|
|
|
21
|
-
A raw `
|
|
21
|
+
A raw `radkfile` buffer
|
|
22
22
|
|
|
23
23
|
### kanjiDic
|
|
24
24
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertTanakaCorpus**(`tanakaString`, `generateFurigana?`): `Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:583](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L583)
|
|
12
12
|
|
|
13
13
|
Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](../interfaces/TanakaExample.md) objects.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **generateAnkiNote**(`entry`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1632](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1632)
|
|
12
12
|
|
|
13
13
|
Generates an array where each field holds an entry’s info wrapped in HTML tags.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **generateAnkiNotesFile**(`list`): `string` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1924](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1924)
|
|
12
12
|
|
|
13
13
|
Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getKanji**(`kanjiChar`, `dict`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1118](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1118)
|
|
12
12
|
|
|
13
13
|
Transforms a converted `KANJIDIC` entry into a more readable format
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getKanjiExtended**(`kanjiChar`, `info`, `dict`, `useJpdbWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1357](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1357)
|
|
12
12
|
|
|
13
13
|
Same as [getKanji](getKanji.md), but with possible extra info.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getWord**(`dict?`, `id?`, `kanjiDic?`, `examples?`, `dictWord?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:903](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L903)
|
|
12
12
|
|
|
13
13
|
Transforms a converted `JMdict` entry into a more readable format, by providing either its [id](#getword) or the [dictWord](#getword) object directly.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isStringArray**(`arg`): `arg is string[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:86](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:86](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L86)
|
|
12
12
|
|
|
13
13
|
Checks if the argument is an array of strings.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isValidArray**(`arg`): `arg is any[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:62](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:62](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L62)
|
|
12
12
|
|
|
13
13
|
Checks if the argument is an array.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isValidArrayWithFirstElement**(`arg`): `arg is any[]`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:71](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:71](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L71)
|
|
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
|
> **makeSSML**(`formText`, `fullReading`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1456](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1456)
|
|
12
12
|
|
|
13
13
|
Builds SSML text for Japanese words
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **shuffleArray**\<`T`\>(`arr`): `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:100](https://github.com/Ronokof/Henkan/blob/
|
|
11
|
+
Defined in: [utils.ts:100](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L100)
|
|
12
12
|
|
|
13
13
|
Shuffles an array using the `Fisher–Yates shuffle` algorithm
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **synthesizeSpeech**(`client`, `ssmlText`, `options`): `Promise`\<`Buffer`\<`ArrayBuffer`\> \| `null`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1541](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/utils.ts#L1541)
|
|
12
12
|
|
|
13
13
|
Synthesizes text to speech audio using \[Amazon Polly\](https://aws.amazon.com/polly/).
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictKanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:
|
|
9
|
+
Defined in: [types.ts:241](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L241)
|
|
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:257](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L257)
|
|
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:245](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L245)
|
|
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:249](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L249)
|
|
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
|
> **readingMeaning**: [`DictKanjiReadingMeaning`](DictKanjiReadingMeaning.md)[]
|
|
50
50
|
|
|
51
|
-
Defined in: [types.ts:
|
|
51
|
+
Defined in: [types.ts:253](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L253)
|
|
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/
|
|
9
|
+
Defined in: [types.ts:16](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/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/
|
|
21
|
+
Defined in: [types.ts:32](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/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/
|
|
35
|
+
Defined in: [types.ts:20](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/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/
|
|
45
|
+
Defined in: [types.ts:26](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/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:
|
|
9
|
+
Defined in: [types.ts:163](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L163)
|
|
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:183](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L183)
|
|
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:177](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L177)
|
|
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:
|
|
49
|
+
Defined in: [types.ts:187](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L187)
|
|
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:
|
|
59
|
+
Defined in: [types.ts:167](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L167)
|
|
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:193](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L193)
|
|
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:197](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L197)
|
|
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:201](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L201)
|
|
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:225](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L225)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:229](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L229)
|
|
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:233](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L233)
|
|
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:209](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L209)
|
|
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:
|
|
21
|
+
Defined in: [types.ts:217](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L217)
|
|
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:
|
|
31
|
+
Defined in: [types.ts:213](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L213)
|
|
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:281](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L281)
|
|
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:285](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L285)
|
|
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:
|
|
29
|
+
Defined in: [types.ts:291](https://github.com/Ronokof/Henkan/blob/874e0ce148c5695af9a488b65483b45b6d79c57b/src/types.ts#L291)
|
|
30
30
|
|
|
31
31
|
The radicals/components that make up the kanji
|
|
32
32
|
|