henkan 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +12 -8
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +9 -5
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +10 -6
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +2 -2
- 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/convertJawiktionary.md +2 -2
- 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/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/getWordDefinitions.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/shuffleArray.md +1 -1
- package/docs/api/functions/synthesizeSpeech.md +2 -2
- package/docs/api/interfaces/Definition.md +4 -4
- package/docs/api/interfaces/DictKanji.md +5 -5
- package/docs/api/interfaces/DictKanjiForm.md +4 -4
- package/docs/api/interfaces/DictKanjiMisc.md +10 -10
- 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 +8 -8
- package/docs/api/interfaces/ExamplePart.md +7 -7
- package/docs/api/interfaces/GlossSpecificNumber.md +3 -3
- package/docs/api/interfaces/Grammar.md +16 -16
- package/docs/api/interfaces/GrammarMeaning.md +3 -3
- package/docs/api/interfaces/Kana.md +11 -11
- package/docs/api/interfaces/Kanji.md +34 -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 +5 -5
- 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 +7 -7
- package/docs/api/interfaces/Translation.md +3 -3
- package/docs/api/interfaces/UsefulRegExps.md +8 -8
- package/docs/api/interfaces/Word.md +15 -15
- package/docs/api/interfaces/WordDefinitionPair.md +3 -3
- package/docs/api/type-aliases/Dict.md +1 -1
- package/docs/api/type-aliases/DictName.md +1 -1
- package/docs/api/type-aliases/DictTranslation.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 +3 -3
package/dist/types/types.d.ts
CHANGED
|
@@ -170,11 +170,11 @@ export interface DictKanjiMisc {
|
|
|
170
170
|
/**
|
|
171
171
|
* The kanji grade level
|
|
172
172
|
*
|
|
173
|
-
* 1-6 -> {@link
|
|
173
|
+
* 1-6 -> {@link https://en.wikipedia.org/wiki/Ky%C5%8Diku_kanji | Kyōiku kanji}
|
|
174
174
|
*
|
|
175
|
-
* 7-8 -> {@link
|
|
175
|
+
* 7-8 -> {@link https://en.wikipedia.org/wiki/J%C5%8Dy%C5%8D_kanji | Jōyō kanji} (excluding Kyōiku kanji)
|
|
176
176
|
*
|
|
177
|
-
* 9-10 -> {@link
|
|
177
|
+
* 9-10 -> {@link https://en.wikipedia.org/wiki/Jinmeiy%C5%8D_kanji | Jinmeiyō kanji}
|
|
178
178
|
*/
|
|
179
179
|
grade?: string | undefined;
|
|
180
180
|
/**
|
|
@@ -184,9 +184,9 @@ export interface DictKanjiMisc {
|
|
|
184
184
|
*/
|
|
185
185
|
frequency?: string | undefined;
|
|
186
186
|
/**
|
|
187
|
-
* The {@link
|
|
187
|
+
* The {@link https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Previous_format_(1984%E2%80%932009) | pre-2010 JLPT} level
|
|
188
188
|
*/
|
|
189
|
-
jlpt?:
|
|
189
|
+
jlpt?: JLPT | undefined;
|
|
190
190
|
}
|
|
191
191
|
/**
|
|
192
192
|
* Kanji reading information
|
|
@@ -565,6 +565,10 @@ export interface Kanji extends ResultEntry<"kanji"> {
|
|
|
565
565
|
* @see {@link DictKanjiMisc.frequency}
|
|
566
566
|
*/
|
|
567
567
|
frequency?: string | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* @see {@link DictKanjiMisc.jlpt}
|
|
570
|
+
*/
|
|
571
|
+
jlpt?: JLPT | undefined;
|
|
568
572
|
/**
|
|
569
573
|
* Whether or not the kanji is kokuji
|
|
570
574
|
*/
|
|
@@ -740,7 +744,7 @@ export interface Grammar extends ResultEntry<"grammar"> {
|
|
|
740
744
|
*/
|
|
741
745
|
phrases?: Phrase[] | undefined;
|
|
742
746
|
/**
|
|
743
|
-
* The {@link
|
|
747
|
+
* The {@link https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Test_format | post-2010 JLPT} level
|
|
744
748
|
*/
|
|
745
749
|
jlpt?: JLPT | undefined;
|
|
746
750
|
/**
|
|
@@ -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;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,GAAG,SAAS,CAAC;IAC7C;;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;;;;OAIG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC/B;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,
|
|
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;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,GAAG,SAAS,CAAC;IAC7C;;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;;;;OAIG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC/B;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,IAAI,GAAG,SAAS,CAAC;CACzB;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,CAAC,EAAE,uBAAuB,EAAE,GAAG,SAAS,CAAC;IACvD;;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,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;CACjC;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,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;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;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ,QAAQ,EAAE,GACV,SAAS,EAAE,GACX,aAAa,EAAE,GACf,WAAW,EAAE,GACb,qBAAqB,EAAE,GACvB,kBAAkB,EAAE,CAAC;AAEzB;;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,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB;;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;IAChC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CACxD;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW,CAAC,MAAM,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B;;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,WAAW,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACvC;;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;;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
|
@@ -69,7 +69,7 @@ export declare function convertKradFile(kradBuffer: Buffer<ArrayBuffer>, kanjiDi
|
|
|
69
69
|
/**
|
|
70
70
|
* Converts and filters a `ja.wiktionary.org` JSONL dump
|
|
71
71
|
*
|
|
72
|
-
* The dump file needs to be converted from a `jawiktionary-latest-pages-articles.xml.bz2` file from {@link https://dumps.wikimedia.org/jawiktionary/latest/} using {@link
|
|
72
|
+
* The dump file needs to be converted from a `jawiktionary-latest-pages-articles.xml.bz2` file from {@link https://dumps.wikimedia.org/jawiktionary/latest/} using {@link https://github.com/tatuylonen/wiktextract | wiktextract}.
|
|
73
73
|
* @param stream The stream of a JSONL dump file
|
|
74
74
|
* @returns An array containing only Japanese entries
|
|
75
75
|
*/
|
|
@@ -123,7 +123,7 @@ export declare function getKanji(dict: DictKanji[], kanjiChar?: string, dictKanj
|
|
|
123
123
|
*/
|
|
124
124
|
export declare function getKanjiExtended(info: Kanji, dict: DictKanji[], kanjiChar?: string, dictKanji?: DictKanji, useWords?: true, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
|
|
125
125
|
/**
|
|
126
|
-
* Synthesizes text to speech audio using {@link
|
|
126
|
+
* Synthesizes text to speech audio using {@link https://aws.amazon.com/polly/ | Amazon Polly}.
|
|
127
127
|
* @param client An Amazon Polly Client instance
|
|
128
128
|
* @param input The input in SSML format or plain text (adjust `TextType` property in `options`)
|
|
129
129
|
* @param options Speech generation settings
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,WAAW,EAEX,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAEL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,WAAW,EAEX,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAEL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,EAEP,IAAI,EACJ,KAAK,EAKL,OAAO,EAEP,MAAM,EACN,aAAa,EAEb,IAAI,EACJ,kBAAkB,EACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAMhC;;;;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,CAiB7C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,GACrC,QAAQ,EAAE,CAgOZ;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,CAsI9D;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,CAwDf;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;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAkD5E;AAwBD;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,GAAG,EAAE,EACd,MAAM,EAAE,QAAQ,EAAE,EAClB,QAAQ,EAAE,SAAS,EAAE,EACrB,gBAAgB,CAAC,EAAE,IAAI,GACtB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CA8V/B;AAqCD;;;;;;;;;;;GAWG;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,WAAW,CAAC,EAAE,kBAAkB,EAAE,EAClC,QAAQ,CAAC,EAAE,QAAQ,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CA8XN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,SAAS,EAAE,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,SAAS,EACrB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAgPP;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,SAAS,EAAE,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,SAAS,EACrB,QAAQ,CAAC,EAAE,IAAI,EACf,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAmDP;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,GAClD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CA4BrC;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;AAsBD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CA8VxD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CA6B5D"}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **capitalizeString**(`value`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:51](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L51)
|
|
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:
|
|
11
|
+
Defined in: [utils.ts:123](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L123)
|
|
12
12
|
|
|
13
13
|
Converts a JMdict `JMdict_e` file into an array of [DictWord](../interfaces/DictWord.md) objects.
|
|
14
14
|
|
|
@@ -8,11 +8,11 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertJawiktionary**(`stream`): `Promise`\<`any`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:779](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L779)
|
|
12
12
|
|
|
13
13
|
Converts and filters a `ja.wiktionary.org` JSONL dump
|
|
14
14
|
|
|
15
|
-
The dump file needs to be converted from a `jawiktionary-latest-pages-articles.xml.bz2` file from [https://dumps.wikimedia.org/jawiktionary/latest/](https://dumps.wikimedia.org/jawiktionary/latest/) using
|
|
15
|
+
The dump file needs to be converted from a `jawiktionary-latest-pages-articles.xml.bz2` file from [https://dumps.wikimedia.org/jawiktionary/latest/](https://dumps.wikimedia.org/jawiktionary/latest/) using [wiktextract](https://github.com/tatuylonen/wiktextract).
|
|
16
16
|
|
|
17
17
|
## Parameters
|
|
18
18
|
|
|
@@ -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:357](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L357)
|
|
12
12
|
|
|
13
13
|
Converts a KANJIDIC `kanjidic2.xml` file into an array of [DictKanji](../interfaces/DictKanji.md) objects.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertKradFile**(`kradBuffer`, `kanjiDic`, `katakanaList`): [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:695](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L695)
|
|
12
12
|
|
|
13
13
|
Converts a `kradfile2` file (EUC-JP encoded) into an array of [DictKanjiWithRadicals](../interfaces/DictKanjiWithRadicals.md) objects.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **convertRadkFile**(`radkBuffer`, `kanjiDic`): [`DictRadical`](../interfaces/DictRadical.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:627](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L627)
|
|
12
12
|
|
|
13
13
|
Converts a `radkfile2` file (EUC-JP encoded) into an array of [DictRadical](../interfaces/DictRadical.md) objects.
|
|
14
14
|
|
|
@@ -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:499](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L499)
|
|
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:2098](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2098)
|
|
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`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2455](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2455)
|
|
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**(`dict`, `kanjiChar?`, `dictKanji?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1669](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1669)
|
|
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**(`info`, `dict`, `kanjiChar?`, `dictKanji?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1932](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1932)
|
|
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?`, `definitions?`, `dictWord?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1265](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L1265)
|
|
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
|
> **getWordDefinitions**(`entries`, `jmDict`, `kanjiDic`, `generateFurigana?`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:861](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L861)
|
|
12
12
|
|
|
13
13
|
Pairs Japanese definitions with JMdict word entries
|
|
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:84](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L84)
|
|
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:
|
|
11
|
+
Defined in: [utils.ts:60](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L60)
|
|
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:
|
|
11
|
+
Defined in: [utils.ts:69](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L69)
|
|
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
|
> **shuffleArray**\<`T`\>(`arr`): `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:98](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L98)
|
|
12
12
|
|
|
13
13
|
Shuffles an array using the `Fisher–Yates shuffle` algorithm
|
|
14
14
|
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
> **synthesizeSpeech**(`client`, `input`, `options`): `Promise`\<`Buffer`\<`ArrayBuffer`\> \| `null`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2002](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2002)
|
|
12
12
|
|
|
13
|
-
Synthesizes text to speech audio using
|
|
13
|
+
Synthesizes text to speech audio using [Amazon Polly](https://aws.amazon.com/polly/).
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Definition
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:383](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:383](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L383)
|
|
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:387](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:387](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L387)
|
|
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:391](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:391](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L391)
|
|
30
30
|
|
|
31
31
|
The definition with furigana attached
|
|
32
32
|
|
|
@@ -36,6 +36,6 @@ The definition with furigana attached
|
|
|
36
36
|
|
|
37
37
|
> `optional` **mayNotBeAccurate**: `true`
|
|
38
38
|
|
|
39
|
-
Defined in: [types.ts:395](https://github.com/Ronokof/Henkan/blob/
|
|
39
|
+
Defined in: [types.ts:395](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L395)
|
|
40
40
|
|
|
41
41
|
Whether or not the definition is associated with other words
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DictKanji
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:249](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:249](https://github.com/Ronokof/Henkan/blob/main/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:265](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:265](https://github.com/Ronokof/Henkan/blob/main/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:253](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:253](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L253)
|
|
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:257](https://github.com/Ronokof/Henkan/blob/
|
|
41
|
+
Defined in: [types.ts:257](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L257)
|
|
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:261](https://github.com/Ronokof/Henkan/blob/
|
|
51
|
+
Defined in: [types.ts:261](https://github.com/Ronokof/Henkan/blob/main/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/
|
|
9
|
+
Defined in: [types.ts:16](https://github.com/Ronokof/Henkan/blob/main/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/main/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/main/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/main/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:171](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:171](https://github.com/Ronokof/Henkan/blob/main/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:191](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:191](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L191)
|
|
22
22
|
|
|
23
23
|
The frequency-of-use ranking
|
|
24
24
|
|
|
@@ -30,25 +30,25 @@ A number from `1` to `2500`
|
|
|
30
30
|
|
|
31
31
|
> `optional` **grade**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:185](https://github.com/Ronokof/Henkan/blob/
|
|
33
|
+
Defined in: [types.ts:185](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L185)
|
|
34
34
|
|
|
35
35
|
The kanji grade level
|
|
36
36
|
|
|
37
|
-
1-6 ->
|
|
37
|
+
1-6 -> [Kyōiku kanji](https://en.wikipedia.org/wiki/Ky%C5%8Diku_kanji)
|
|
38
38
|
|
|
39
|
-
7-8 ->
|
|
39
|
+
7-8 -> [Jōyō kanji](https://en.wikipedia.org/wiki/J%C5%8Dy%C5%8D_kanji) (excluding Kyōiku kanji)
|
|
40
40
|
|
|
41
|
-
9-10 ->
|
|
41
|
+
9-10 -> [Jinmeiyō kanji](https://en.wikipedia.org/wiki/Jinmeiy%C5%8D_kanji)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
45
|
### jlpt?
|
|
46
46
|
|
|
47
|
-
> `optional` **jlpt**: `
|
|
47
|
+
> `optional` **jlpt**: [`JLPT`](../type-aliases/JLPT.md)
|
|
48
48
|
|
|
49
|
-
Defined in: [types.ts:195](https://github.com/Ronokof/Henkan/blob/
|
|
49
|
+
Defined in: [types.ts:195](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L195)
|
|
50
50
|
|
|
51
|
-
The
|
|
51
|
+
The [pre-2010 JLPT](https://en.wikipedia.org/wiki/Japanese-Language_Proficiency_Test#Previous_format_(1984%E2%80%932009)) level
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
@@ -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:175](https://github.com/Ronokof/Henkan/blob/
|
|
59
|
+
Defined in: [types.ts:175](https://github.com/Ronokof/Henkan/blob/main/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:201](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:201](https://github.com/Ronokof/Henkan/blob/main/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:205](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:205](https://github.com/Ronokof/Henkan/blob/main/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:209](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:209](https://github.com/Ronokof/Henkan/blob/main/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:233](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:233](https://github.com/Ronokof/Henkan/blob/main/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:237](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:237](https://github.com/Ronokof/Henkan/blob/main/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:241](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:241](https://github.com/Ronokof/Henkan/blob/main/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:217](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:217](https://github.com/Ronokof/Henkan/blob/main/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:225](https://github.com/Ronokof/Henkan/blob/
|
|
21
|
+
Defined in: [types.ts:225](https://github.com/Ronokof/Henkan/blob/main/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:221](https://github.com/Ronokof/Henkan/blob/
|
|
31
|
+
Defined in: [types.ts:221](https://github.com/Ronokof/Henkan/blob/main/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:289](https://github.com/Ronokof/Henkan/blob/
|
|
9
|
+
Defined in: [types.ts:289](https://github.com/Ronokof/Henkan/blob/main/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:293](https://github.com/Ronokof/Henkan/blob/
|
|
19
|
+
Defined in: [types.ts:293](https://github.com/Ronokof/Henkan/blob/main/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:299](https://github.com/Ronokof/Henkan/blob/
|
|
29
|
+
Defined in: [types.ts:299](https://github.com/Ronokof/Henkan/blob/main/src/types.ts#L299)
|
|
30
30
|
|
|
31
31
|
The radicals/components that make up the kanji
|
|
32
32
|
|