henkan 0.9.2 → 1.0.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/CONTRIBUTING.md +0 -0
- package/LICENSE.md +0 -0
- package/README.md +1 -1
- package/SECURITY.md +0 -0
- package/dist/index.cjs.js +432 -77
- package/dist/index.cjs.js.map +2 -2
- package/dist/index.mjs +427 -77
- package/dist/index.mjs.map +2 -2
- package/dist/types/types.d.ts +43 -5
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +32 -11
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/README.md +5 -0
- package/docs/api/functions/capitalizeString.md +1 -1
- package/docs/api/functions/convertJMdict.md +1 -1
- package/docs/api/functions/convertJawiktionary.md +29 -0
- 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 +2 -2
- package/docs/api/functions/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +4 -4
- package/docs/api/functions/getKanji.md +12 -6
- package/docs/api/functions/getKanjiExtended.md +17 -11
- package/docs/api/functions/getWord.md +8 -2
- package/docs/api/functions/getWordDefinitions.md +45 -0
- 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 +1 -1
- package/docs/api/interfaces/Definition.md +41 -0
- package/docs/api/interfaces/DictKanji.md +7 -7
- 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 +12 -12
- 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 +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 +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 +24 -14
- package/docs/api/interfaces/WordDefinitionPair.md +31 -0
- 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 +13 -0
- 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 +16 -9
package/dist/types/types.d.ts
CHANGED
|
@@ -56,6 +56,13 @@ export interface DictReading {
|
|
|
56
56
|
*/
|
|
57
57
|
kanjiFormRestrictions?: string[] | undefined;
|
|
58
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* A JMdict sense translation
|
|
61
|
+
*/
|
|
62
|
+
export type DictTranslation = string | {
|
|
63
|
+
translation: string;
|
|
64
|
+
type: "lit" | "expl" | "tm";
|
|
65
|
+
};
|
|
59
66
|
/**
|
|
60
67
|
* Word meaning/sense information
|
|
61
68
|
*
|
|
@@ -71,10 +78,7 @@ export interface DictMeaning {
|
|
|
71
78
|
/**
|
|
72
79
|
* Word glosses
|
|
73
80
|
*/
|
|
74
|
-
translations?:
|
|
75
|
-
translation: string;
|
|
76
|
-
type: "lit" | "expl" | "tm";
|
|
77
|
-
})[] | undefined;
|
|
81
|
+
translations?: DictTranslation[] | undefined;
|
|
78
82
|
/**
|
|
79
83
|
* Cross-references to other similar/related words *(when used with this meaning)*
|
|
80
84
|
*/
|
|
@@ -244,7 +248,7 @@ export interface DictKanji {
|
|
|
244
248
|
/**
|
|
245
249
|
* The "readings-meanings" groups and nanori readings of the kanji
|
|
246
250
|
*/
|
|
247
|
-
readingMeaning
|
|
251
|
+
readingMeaning?: DictKanjiReadingMeaning[] | undefined;
|
|
248
252
|
/**
|
|
249
253
|
* Whether or not the kanji is kokuji
|
|
250
254
|
*/
|
|
@@ -357,6 +361,36 @@ export interface TanakaExample {
|
|
|
357
361
|
*/
|
|
358
362
|
glossNumber?: GlossSpecificNumber | undefined;
|
|
359
363
|
}
|
|
364
|
+
/**
|
|
365
|
+
* A word definition
|
|
366
|
+
*/
|
|
367
|
+
export interface Definition {
|
|
368
|
+
/**
|
|
369
|
+
* The definition
|
|
370
|
+
*/
|
|
371
|
+
definition: string;
|
|
372
|
+
/**
|
|
373
|
+
* The definition with furigana attached
|
|
374
|
+
*/
|
|
375
|
+
furigana?: string | undefined;
|
|
376
|
+
/**
|
|
377
|
+
* Whether or not the definition is associated with other words
|
|
378
|
+
*/
|
|
379
|
+
mayNotBeAccurate?: true | undefined;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* A word paired with its definitions
|
|
383
|
+
*/
|
|
384
|
+
export interface WordDefinitionPair {
|
|
385
|
+
/**
|
|
386
|
+
* The word's JMdict entry ID
|
|
387
|
+
*/
|
|
388
|
+
wordID: string;
|
|
389
|
+
/**
|
|
390
|
+
* The word definitions
|
|
391
|
+
*/
|
|
392
|
+
definitions: Definition[];
|
|
393
|
+
}
|
|
360
394
|
/**
|
|
361
395
|
* Any type of entry list
|
|
362
396
|
*/
|
|
@@ -634,6 +668,10 @@ export interface Word extends ResultEntry<"word"> {
|
|
|
634
668
|
* Phrases associated to the word
|
|
635
669
|
*/
|
|
636
670
|
phrases?: Phrase[] | undefined;
|
|
671
|
+
/**
|
|
672
|
+
* Japanese definitions associated with the word
|
|
673
|
+
*/
|
|
674
|
+
definitions?: Definition[] | undefined;
|
|
637
675
|
/**
|
|
638
676
|
* @see {@link DictWord.isCommon}
|
|
639
677
|
*/
|
|
@@ -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;
|
|
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,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,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,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;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
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { PollyClient, SynthesizeSpeechCommandInput } from "@aws-sdk/client-polly";
|
|
2
|
-
import { DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, Kana, Kanji, Radical, Result, TanakaExample, Word } from "./types";
|
|
2
|
+
import { DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, Kana, Kanji, Radical, Result, TanakaExample, Word, WordDefinitionPair } from "./types";
|
|
3
|
+
import { ReadStream } from "fs";
|
|
3
4
|
/**
|
|
4
5
|
* Capitalizes a string.
|
|
5
6
|
* @param value The string to capitalize
|
|
@@ -46,7 +47,7 @@ export declare function convertKanjiDic(xmlString: string): DictKanji[];
|
|
|
46
47
|
/**
|
|
47
48
|
* Converts a Tanaka Corpus `examples.utf` file into an array of {@link TanakaExample} objects.
|
|
48
49
|
* @param tanakaString The raw contents of a `examples.utf` file
|
|
49
|
-
* @param generateFurigana Whether or not to generate furigana for the
|
|
50
|
+
* @param generateFurigana Whether or not to generate furigana for the phrases
|
|
50
51
|
* @returns A promise resolving with an array of converted {@link TanakaExample} objects
|
|
51
52
|
*/
|
|
52
53
|
export declare function convertTanakaCorpus(tanakaString: string, generateFurigana?: true): Promise<TanakaExample[]>;
|
|
@@ -65,42 +66,62 @@ export declare function convertRadkFile(radkBuffer: Buffer<ArrayBuffer>, kanjiDi
|
|
|
65
66
|
* @returns An array of converted {@link DictKanjiWithRadicals} objects
|
|
66
67
|
*/
|
|
67
68
|
export declare function convertKradFile(kradBuffer: Buffer<ArrayBuffer>, kanjiDic: DictKanji[], katakanaList: Kana[]): DictKanjiWithRadicals[];
|
|
69
|
+
/**
|
|
70
|
+
* Converts and filters a `ja.wiktionary.org` JSONL dump
|
|
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 [wiktextract](https://github.com/tatuylonen/wiktextract)}.
|
|
73
|
+
* @param stream The stream of a JSONL dump file
|
|
74
|
+
* @returns An array containing only Japanese entries
|
|
75
|
+
*/
|
|
76
|
+
export declare function convertJawiktionary(stream: ReadStream): Promise<any[]>;
|
|
77
|
+
/**
|
|
78
|
+
* Pairs Japanese definitions with JMdict word entries
|
|
79
|
+
* @param entries An array containing `ja.wiktionary.org` Japanese entries (converted using {@link convertJawiktionary})
|
|
80
|
+
* @param jmDict An array of converted `JMdict` entries
|
|
81
|
+
* @param kanjiDic An array of converted `KANJIDIC` entries
|
|
82
|
+
* @param generateFurigana Whether or not to generate furigana for the definitions
|
|
83
|
+
* @returns A promise resolving with an array of {@link WordDefinitionPair} objects
|
|
84
|
+
*/
|
|
85
|
+
export declare function getWordDefinitions(entries: any[], jmDict: DictWord[], kanjiDic: DictKanji[], generateFurigana?: true): Promise<WordDefinitionPair[]>;
|
|
68
86
|
/**
|
|
69
87
|
* Transforms a converted `JMdict` entry into a more readable format, by providing either its {@link id} or the {@link dictWord} object directly.
|
|
70
88
|
* @param dict An array of converted `JMdict` entries
|
|
71
89
|
* @param id The ID of the `JMdict` entry
|
|
72
90
|
* @param kanjiDic An array of converted `KANJIDIC` entries
|
|
73
91
|
* @param examples An array of converted `Tanaka Corpus` examples
|
|
92
|
+
* @param definitions An array of `ja.wiktionary.org` word definitions
|
|
74
93
|
* @param dictWord The converted `JMdict` entry
|
|
75
94
|
* @param noteTypeName The Anki note type name
|
|
76
95
|
* @param deckPath The full Anki deck path
|
|
77
96
|
* @returns The transformed {@link Word} object
|
|
78
97
|
*/
|
|
79
|
-
export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
|
|
98
|
+
export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], definitions?: WordDefinitionPair[], dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
|
|
80
99
|
/**
|
|
81
100
|
* Transforms a converted `KANJIDIC` entry into a more readable format
|
|
82
|
-
* @param kanjiChar The kanji character
|
|
83
101
|
* @param dict An array of converted `KANJIDIC` entries
|
|
102
|
+
* @param kanjiChar The kanji character
|
|
103
|
+
* @param dictKanji A {@link DictKanji} object
|
|
84
104
|
* @param jmDict An array of converted `JMdict` entries
|
|
85
105
|
* @param svgList An array of SVG file names
|
|
86
106
|
* @param noteTypeName The Anki note type name
|
|
87
107
|
* @param deckPath The full Anki deck path
|
|
88
108
|
* @returns The transformed {@link Kanji} object
|
|
89
109
|
*/
|
|
90
|
-
export declare function getKanji(
|
|
110
|
+
export declare function getKanji(dict: DictKanji[], kanjiChar?: string, dictKanji?: DictKanji, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
|
|
91
111
|
/**
|
|
92
112
|
* Same as {@link getKanji}, but with possible extra info.
|
|
93
|
-
* @param
|
|
94
|
-
* @param info Additional info from `jpdb.io` for the kanji (mnemonic, components, words)
|
|
113
|
+
* @param info Additional info for the kanji (mnemonic, components, words)
|
|
95
114
|
* @param dict An array of converted `KANJIDIC` entries
|
|
96
|
-
* @param
|
|
115
|
+
* @param kanjiChar The kanji character
|
|
116
|
+
* @param dictKanji A {@link DictKanji} object
|
|
117
|
+
* @param useWords Whether or not to use the words provided in the `info` object (if present) instead of other words from `JMdict`
|
|
97
118
|
* @param jmDict An array of converted `JMdict` entries
|
|
98
119
|
* @param svgList An array of SVG file names
|
|
99
120
|
* @param noteTypeName The Anki note type name
|
|
100
121
|
* @param deckPath The full Anki deck path
|
|
101
122
|
* @returns The transformed {@link Kanji} object
|
|
102
123
|
*/
|
|
103
|
-
export declare function getKanjiExtended(
|
|
124
|
+
export declare function getKanjiExtended(info: Kanji, dict: DictKanji[], kanjiChar?: string, dictKanji?: DictKanji, useWords?: true, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
|
|
104
125
|
/**
|
|
105
126
|
* Synthesizes text to speech audio using {@link [Amazon Polly](https://aws.amazon.com/polly/)}.
|
|
106
127
|
* @param client An Amazon Polly Client instance
|
|
@@ -123,7 +144,7 @@ export declare function generateAnkiNote(entry: Result): string[];
|
|
|
123
144
|
/**
|
|
124
145
|
* Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
|
|
125
146
|
* @param list An array containing any type of transformed entries ({@link Word}, {@link Kanji}, {@link Radical}, {@link Kana}, {@link Grammar})
|
|
126
|
-
* @returns The resulting Anki notes file's content
|
|
147
|
+
* @returns The resulting Anki notes file's content
|
|
127
148
|
*/
|
|
128
|
-
export declare function generateAnkiNotesFile(list: Result[]): string
|
|
149
|
+
export declare function generateAnkiNotesFile(list: Result[]): string;
|
|
129
150
|
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -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,
|
|
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,EACP,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,CAqI9D;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,CAwOP;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"}
|
package/docs/api/README.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
## Interfaces
|
|
8
8
|
|
|
9
|
+
- [Definition](interfaces/Definition.md)
|
|
9
10
|
- [DictKanji](interfaces/DictKanji.md)
|
|
10
11
|
- [DictKanjiForm](interfaces/DictKanjiForm.md)
|
|
11
12
|
- [DictKanjiMisc](interfaces/DictKanjiMisc.md)
|
|
@@ -34,11 +35,13 @@
|
|
|
34
35
|
- [Translation](interfaces/Translation.md)
|
|
35
36
|
- [UsefulRegExps](interfaces/UsefulRegExps.md)
|
|
36
37
|
- [Word](interfaces/Word.md)
|
|
38
|
+
- [WordDefinitionPair](interfaces/WordDefinitionPair.md)
|
|
37
39
|
|
|
38
40
|
## Type Aliases
|
|
39
41
|
|
|
40
42
|
- [Dict](type-aliases/Dict.md)
|
|
41
43
|
- [DictName](type-aliases/DictName.md)
|
|
44
|
+
- [DictTranslation](type-aliases/DictTranslation.md)
|
|
42
45
|
- [EntryType](type-aliases/EntryType.md)
|
|
43
46
|
- [JLPT](type-aliases/JLPT.md)
|
|
44
47
|
- [Result](type-aliases/Result.md)
|
|
@@ -46,6 +49,7 @@
|
|
|
46
49
|
## Functions
|
|
47
50
|
|
|
48
51
|
- [capitalizeString](functions/capitalizeString.md)
|
|
52
|
+
- [convertJawiktionary](functions/convertJawiktionary.md)
|
|
49
53
|
- [convertJMdict](functions/convertJMdict.md)
|
|
50
54
|
- [convertKanjiDic](functions/convertKanjiDic.md)
|
|
51
55
|
- [convertKradFile](functions/convertKradFile.md)
|
|
@@ -56,6 +60,7 @@
|
|
|
56
60
|
- [getKanji](functions/getKanji.md)
|
|
57
61
|
- [getKanjiExtended](functions/getKanjiExtended.md)
|
|
58
62
|
- [getWord](functions/getWord.md)
|
|
63
|
+
- [getWordDefinitions](functions/getWordDefinitions.md)
|
|
59
64
|
- [isStringArray](functions/isStringArray.md)
|
|
60
65
|
- [isValidArray](functions/isValidArray.md)
|
|
61
66
|
- [isValidArrayWithFirstElement](functions/isValidArrayWithFirstElement.md)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **capitalizeString**(`value`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:50](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L50)
|
|
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:122](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L122)
|
|
12
12
|
|
|
13
13
|
Converts a JMdict `JMdict_e` file into an array of [DictWord](../interfaces/DictWord.md) objects.
|
|
14
14
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**henkan**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[henkan](../README.md) / convertJawiktionary
|
|
6
|
+
|
|
7
|
+
# Function: convertJawiktionary()
|
|
8
|
+
|
|
9
|
+
> **convertJawiktionary**(`stream`): `Promise`\<`any`[]\>
|
|
10
|
+
|
|
11
|
+
Defined in: [utils.ts:777](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L777)
|
|
12
|
+
|
|
13
|
+
Converts and filters a `ja.wiktionary.org` JSONL dump
|
|
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 \[wiktextract\](https://github.com/tatuylonen/wiktextract).
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
### stream
|
|
20
|
+
|
|
21
|
+
`ReadStream`
|
|
22
|
+
|
|
23
|
+
The stream of a JSONL dump file
|
|
24
|
+
|
|
25
|
+
## Returns
|
|
26
|
+
|
|
27
|
+
`Promise`\<`any`[]\>
|
|
28
|
+
|
|
29
|
+
An array containing only Japanese entries
|
|
@@ -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:356](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L356)
|
|
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:693](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L693)
|
|
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:625](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L625)
|
|
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:497](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L497)
|
|
12
12
|
|
|
13
13
|
Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](../interfaces/TanakaExample.md) objects.
|
|
14
14
|
|
|
@@ -24,7 +24,7 @@ The raw contents of a `examples.utf` file
|
|
|
24
24
|
|
|
25
25
|
`true`
|
|
26
26
|
|
|
27
|
-
Whether or not to generate furigana for the
|
|
27
|
+
Whether or not to generate furigana for the phrases
|
|
28
28
|
|
|
29
29
|
## Returns
|
|
30
30
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **generateAnkiNote**(`entry`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2088](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L2088)
|
|
12
12
|
|
|
13
13
|
Generates an array where each field holds an entry’s info wrapped in HTML tags.
|
|
14
14
|
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: generateAnkiNotesFile()
|
|
8
8
|
|
|
9
|
-
> **generateAnkiNotesFile**(`list`): `string`
|
|
9
|
+
> **generateAnkiNotesFile**(`list`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2445](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L2445)
|
|
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
|
|
|
@@ -22,6 +22,6 @@ An array containing any type of transformed entries ([Word](../interfaces/Word.m
|
|
|
22
22
|
|
|
23
23
|
## Returns
|
|
24
24
|
|
|
25
|
-
`string`
|
|
25
|
+
`string`
|
|
26
26
|
|
|
27
|
-
The resulting Anki notes file's content
|
|
27
|
+
The resulting Anki notes file's content
|
|
@@ -6,25 +6,31 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: getKanji()
|
|
8
8
|
|
|
9
|
-
> **getKanji**(`
|
|
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:1667](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L1667)
|
|
12
12
|
|
|
13
13
|
Transforms a converted `KANJIDIC` entry into a more readable format
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
###
|
|
17
|
+
### dict
|
|
18
|
+
|
|
19
|
+
[`DictKanji`](../interfaces/DictKanji.md)[]
|
|
20
|
+
|
|
21
|
+
An array of converted `KANJIDIC` entries
|
|
22
|
+
|
|
23
|
+
### kanjiChar?
|
|
18
24
|
|
|
19
25
|
`string`
|
|
20
26
|
|
|
21
27
|
The kanji character
|
|
22
28
|
|
|
23
|
-
###
|
|
29
|
+
### dictKanji?
|
|
24
30
|
|
|
25
|
-
[`DictKanji`](../interfaces/DictKanji.md)
|
|
31
|
+
[`DictKanji`](../interfaces/DictKanji.md)
|
|
26
32
|
|
|
27
|
-
|
|
33
|
+
A [DictKanji](../interfaces/DictKanji.md) object
|
|
28
34
|
|
|
29
35
|
### jmDict?
|
|
30
36
|
|
|
@@ -6,25 +6,19 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: getKanjiExtended()
|
|
8
8
|
|
|
9
|
-
> **getKanjiExtended**(`
|
|
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:1922](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L1922)
|
|
12
12
|
|
|
13
13
|
Same as [getKanji](getKanji.md), but with possible extra info.
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
### kanjiChar
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
The kanji character
|
|
22
|
-
|
|
23
17
|
### info
|
|
24
18
|
|
|
25
19
|
[`Kanji`](../interfaces/Kanji.md)
|
|
26
20
|
|
|
27
|
-
Additional info
|
|
21
|
+
Additional info for the kanji (mnemonic, components, words)
|
|
28
22
|
|
|
29
23
|
### dict
|
|
30
24
|
|
|
@@ -32,11 +26,23 @@ Additional info from `jpdb.io` for the kanji (mnemonic, components, words)
|
|
|
32
26
|
|
|
33
27
|
An array of converted `KANJIDIC` entries
|
|
34
28
|
|
|
35
|
-
###
|
|
29
|
+
### kanjiChar?
|
|
30
|
+
|
|
31
|
+
`string`
|
|
32
|
+
|
|
33
|
+
The kanji character
|
|
34
|
+
|
|
35
|
+
### dictKanji?
|
|
36
|
+
|
|
37
|
+
[`DictKanji`](../interfaces/DictKanji.md)
|
|
38
|
+
|
|
39
|
+
A [DictKanji](../interfaces/DictKanji.md) object
|
|
40
|
+
|
|
41
|
+
### useWords?
|
|
36
42
|
|
|
37
43
|
`true`
|
|
38
44
|
|
|
39
|
-
Whether or not to use the `
|
|
45
|
+
Whether or not to use the words provided in the `info` object (if present) instead of other words from `JMdict`
|
|
40
46
|
|
|
41
47
|
### jmDict?
|
|
42
48
|
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: getWord()
|
|
8
8
|
|
|
9
|
-
> **getWord**(`dict?`, `id?`, `kanjiDic?`, `examples?`, `dictWord?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md)
|
|
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:1263](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L1263)
|
|
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
|
|
|
@@ -38,6 +38,12 @@ An array of converted `KANJIDIC` entries
|
|
|
38
38
|
|
|
39
39
|
An array of converted `Tanaka Corpus` examples
|
|
40
40
|
|
|
41
|
+
### definitions?
|
|
42
|
+
|
|
43
|
+
[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
|
|
44
|
+
|
|
45
|
+
An array of `ja.wiktionary.org` word definitions
|
|
46
|
+
|
|
41
47
|
### dictWord?
|
|
42
48
|
|
|
43
49
|
[`DictWord`](../interfaces/DictWord.md)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**henkan**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[henkan](../README.md) / getWordDefinitions
|
|
6
|
+
|
|
7
|
+
# Function: getWordDefinitions()
|
|
8
|
+
|
|
9
|
+
> **getWordDefinitions**(`entries`, `jmDict`, `kanjiDic`, `generateFurigana?`): `Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
|
|
10
|
+
|
|
11
|
+
Defined in: [utils.ts:859](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L859)
|
|
12
|
+
|
|
13
|
+
Pairs Japanese definitions with JMdict word entries
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### entries
|
|
18
|
+
|
|
19
|
+
`any`[]
|
|
20
|
+
|
|
21
|
+
An array containing `ja.wiktionary.org` Japanese entries (converted using [convertJawiktionary](convertJawiktionary.md))
|
|
22
|
+
|
|
23
|
+
### jmDict
|
|
24
|
+
|
|
25
|
+
[`DictWord`](../interfaces/DictWord.md)[]
|
|
26
|
+
|
|
27
|
+
An array of converted `JMdict` entries
|
|
28
|
+
|
|
29
|
+
### kanjiDic
|
|
30
|
+
|
|
31
|
+
[`DictKanji`](../interfaces/DictKanji.md)[]
|
|
32
|
+
|
|
33
|
+
An array of converted `KANJIDIC` entries
|
|
34
|
+
|
|
35
|
+
### generateFurigana?
|
|
36
|
+
|
|
37
|
+
`true`
|
|
38
|
+
|
|
39
|
+
Whether or not to generate furigana for the definitions
|
|
40
|
+
|
|
41
|
+
## Returns
|
|
42
|
+
|
|
43
|
+
`Promise`\<[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]\>
|
|
44
|
+
|
|
45
|
+
A promise resolving with an array of [WordDefinitionPair](../interfaces/WordDefinitionPair.md) objects
|
|
@@ -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:83](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L83)
|
|
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:59](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L59)
|
|
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:68](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L68)
|
|
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:97](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L97)
|
|
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`, `input`, `options`): `Promise`\<`Buffer`\<`ArrayBuffer`\> \| `null`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:1992](https://github.com/Ronokof/Henkan/blob/ce374b7e2b0828c4af4955d9fe995f8c548c2fd2/src/utils.ts#L1992)
|
|
12
12
|
|
|
13
13
|
Synthesizes text to speech audio using \[Amazon Polly\](https://aws.amazon.com/polly/).
|
|
14
14
|
|