henkan 1.1.1 → 2.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.
Files changed (51) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs.js +1051 -1118
  3. package/dist/index.cjs.js.map +3 -3
  4. package/dist/index.mjs +1044 -1114
  5. package/dist/index.mjs.map +3 -3
  6. package/dist/types/constants.d.ts +3 -2
  7. package/dist/types/constants.d.ts.map +1 -1
  8. package/dist/types/types.d.ts +74 -15
  9. package/dist/types/types.d.ts.map +1 -1
  10. package/dist/types/utils.d.ts +49 -40
  11. package/dist/types/utils.d.ts.map +1 -1
  12. package/docs/api/README.md +6 -2
  13. package/docs/api/functions/capitalizeString.md +1 -1
  14. package/docs/api/functions/convertJMdict.md +2 -2
  15. package/docs/api/functions/convertJawiktionaryAsync.md +29 -0
  16. package/docs/api/functions/convertJawiktionarySync.md +29 -0
  17. package/docs/api/functions/convertKanjiDic.md +1 -1
  18. package/docs/api/functions/convertKradFile.md +3 -3
  19. package/docs/api/functions/convertRadkFile.md +2 -2
  20. package/docs/api/functions/convertTanakaCorpus.md +3 -9
  21. package/docs/api/functions/convertTanakaCorpusWithFurigana.md +27 -0
  22. package/docs/api/functions/generateAnkiNote.md +1 -1
  23. package/docs/api/functions/generateAnkiNotesFile.md +9 -3
  24. package/docs/api/functions/getKanji.md +13 -19
  25. package/docs/api/functions/getKanjiExtended.md +18 -18
  26. package/docs/api/functions/getWord.md +17 -23
  27. package/docs/api/functions/getWordDefinitions.md +6 -12
  28. package/docs/api/functions/getWordDefinitionsWithFurigana.md +33 -0
  29. package/docs/api/functions/isStringArray.md +1 -1
  30. package/docs/api/functions/isValidArray.md +1 -1
  31. package/docs/api/functions/isValidArrayWithFirstElement.md +1 -1
  32. package/docs/api/functions/shuffleArray.md +2 -2
  33. package/docs/api/interfaces/DefaultNoteInfo.md +51 -0
  34. package/docs/api/interfaces/DictKanjiMisc.md +2 -2
  35. package/docs/api/interfaces/DictKanjiReadingMeaning.md +2 -2
  36. package/docs/api/interfaces/DictKanjiReadingMeaningGroup.md +4 -4
  37. package/docs/api/interfaces/DictKanjiWithRadicals.md +2 -2
  38. package/docs/api/interfaces/DictWord.md +1 -1
  39. package/docs/api/interfaces/Grammar.md +2 -2
  40. package/docs/api/interfaces/Kana.md +2 -2
  41. package/docs/api/interfaces/Kanji.md +12 -12
  42. package/docs/api/interfaces/NoteAndTag.md +2 -2
  43. package/docs/api/interfaces/NoteHeaderKeys.md +75 -0
  44. package/docs/api/interfaces/Radical.md +5 -5
  45. package/docs/api/interfaces/ResultEntry.md +2 -2
  46. package/docs/api/interfaces/TanakaExample.md +1 -1
  47. package/docs/api/interfaces/UsefulRegExps.md +8 -8
  48. package/docs/api/interfaces/Word.md +2 -2
  49. package/package.json +11 -12
  50. package/docs/api/functions/convertJawiktionary.md +0 -29
  51. package/docs/api/functions/synthesizeSpeech.md +0 -39
@@ -1,5 +1,6 @@
1
- import { POS, UsefulRegExps } from "./types";
1
+ import { NoteHeaderKeys, POS, UsefulRegExps } from "./types";
2
2
  export declare const regexps: UsefulRegExps;
3
+ export declare const noteHeaderKeys: NoteHeaderKeys;
3
4
  export declare const notSearchedForms: Set<string>;
4
- export declare const noteMap: Map<string, readonly [string, string] | readonly [string, string, POS | POS[]]>;
5
+ export declare const noteMap: Map<string, readonly [string, string] | readonly [string, string, POS | readonly POS[]]>;
5
6
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,OAAO,EAAE,aASrB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAgBvC,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,GAAG,CACvB,MAAM,EACN,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC,CAinClE,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7D,eAAO,MAAM,OAAO,EAAE,aASrB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,cAO5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAgBvC,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,GAAG,CACvB,MAAM,EACN,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,SAAS,GAAG,EAAE,CAAC,CAinC3E,CAAC"}
@@ -131,7 +131,7 @@ export interface DictWord {
131
131
  /**
132
132
  * The entry sequence number
133
133
  */
134
- readonly id: string;
134
+ readonly id: `${number}`;
135
135
  /**
136
136
  * The word's kanji forms
137
137
  */
@@ -170,7 +170,7 @@ export interface DictKanjiMisc {
170
170
  /**
171
171
  * The stroke count of the kanji, including the radical
172
172
  */
173
- readonly strokeNumber: string;
173
+ strokeNumber?: string | undefined;
174
174
  /**
175
175
  * The kanji grade level
176
176
  *
@@ -214,11 +214,11 @@ export interface DictKanjiReadingMeaningGroup {
214
214
  /**
215
215
  * The kanji readings
216
216
  */
217
- readings: DictKanjiReading[];
217
+ readings?: DictKanjiReading[] | undefined;
218
218
  /**
219
219
  * The kanji meanings
220
220
  */
221
- meanings: string[];
221
+ meanings?: string[] | undefined;
222
222
  }
223
223
  /**
224
224
  * Kanji "readings-meanings" groups and nanori readings
@@ -229,7 +229,7 @@ export interface DictKanjiReadingMeaning {
229
229
  /**
230
230
  * The Kanji "readings-meanings" pairs
231
231
  */
232
- groups: DictKanjiReadingMeaningGroup[];
232
+ groups?: DictKanjiReadingMeaningGroup[] | undefined;
233
233
  /**
234
234
  * The kanji nanori readings
235
235
  */
@@ -286,9 +286,9 @@ export interface DictKanjiWithRadicals {
286
286
  /**
287
287
  * The radicals/components that make up the kanji
288
288
  *
289
- * Can be {@link DictKanji} objects if the component is a kanji found in KANJIDIC and/or {@link Kana.kana} if the component is a katakana character that does not use (or have) its (or a) kanji variant.
289
+ * Can be {@link DictKanji} objects with either an actual kanji or a katakana character (which takes the place of the missing kanji)
290
290
  */
291
- radicals: (DictKanji | string)[];
291
+ radicals: DictKanji[];
292
292
  }
293
293
  /**
294
294
  * A word/part from the `B` section of a Tanaka Corpus `examples.utf` entry
@@ -359,7 +359,7 @@ export interface TanakaExample {
359
359
  /**
360
360
  * The Japanese phrase, with furigana attached
361
361
  */
362
- readonly furigana?: string | undefined;
362
+ furigana?: string | undefined;
363
363
  /**
364
364
  * The word-gloss pair
365
365
  */
@@ -438,11 +438,11 @@ export interface ResultEntry<EntryType extends string> {
438
438
  /**
439
439
  * ID used for the resulting Anki note
440
440
  */
441
- readonly noteID?: `${EntryType}_${string}` | undefined;
441
+ noteID?: `${`${EntryType}_` | ""}${string}` | undefined;
442
442
  /**
443
443
  * ID used for the Anki note ID
444
444
  */
445
- readonly id?: string | undefined;
445
+ id?: `${number}` | undefined;
446
446
  /**
447
447
  * Anki note type name
448
448
  */
@@ -467,7 +467,7 @@ export interface NoteAndTag {
467
467
  /**
468
468
  * The note
469
469
  */
470
- readonly note?: string | undefined;
470
+ readonly note: string;
471
471
  /**
472
472
  * The tag
473
473
  */
@@ -610,9 +610,9 @@ export interface Kanji extends ResultEntry<"kanji"> {
610
610
  */
611
611
  source?: string | undefined;
612
612
  /**
613
- * Whether or not this kanji object contains information **only** from `jpdb.io`
613
+ * Whether or not this kanji object contains information extracted from {@link source}
614
614
  */
615
- fromJpdb?: true | undefined;
615
+ externalInfo?: true | undefined;
616
616
  }
617
617
  /**
618
618
  * Kanji radical/component information
@@ -651,9 +651,9 @@ export interface Radical extends ResultEntry<"radical"> {
651
651
  */
652
652
  sources?: string[] | undefined;
653
653
  /**
654
- * Whether or not this radical/component object contains information **only** from `jpdb.io`
654
+ * Whether or not this radical/component object contains information extracted from {@link sources}
655
655
  */
656
- fromJpdb?: true | undefined;
656
+ externalInfo?: true | undefined;
657
657
  }
658
658
  /**
659
659
  * Phrase information
@@ -792,6 +792,65 @@ export interface Grammar extends ResultEntry<"grammar"> {
792
792
  * Any type of converted entry from a {@link Dict} array + others not from a dictionary
793
793
  */
794
794
  export type Result = Word | Kanji | Radical | Kana | Grammar;
795
+ /**
796
+ * Default note ID, note type and deck name of a note
797
+ *
798
+ * Setting any of the properties to:
799
+ *
800
+ * - a `string` will make that string the default note ID/note type/deck name of the note in case {@link Result.noteID}/{@link Result.noteTypeName}/{@link Result.deckPath} is `undefined`.
801
+ *
802
+ * - `true` will require all {@link Result} objects to have {@link Result.noteID}/{@link Result.noteTypeName}/{@link Result.deckPath} set (*no default values*).
803
+ *
804
+ * - `undefined` (*or not set*) will require all {@link Result} objects to either have {@link Result.noteID}/{@link Result.noteTypeName}/{@link Result.deckPath} set or not set (*no default values*).
805
+ *
806
+ */
807
+ export interface DefaultNoteInfo {
808
+ /**
809
+ * A default for {@link Result.noteID}
810
+ *
811
+ * `main_information` will make either the ID or kana/kanji/radical character the default note ID of the note.
812
+ */
813
+ guid?: "main_information" | true | undefined;
814
+ /**
815
+ * A default for {@link Result.noteTypeName}
816
+ */
817
+ noteType?: string | true | undefined;
818
+ /**
819
+ * A default for {@link Result.deckPath}
820
+ */
821
+ deckPath?: string | true | undefined;
822
+ }
823
+ /**
824
+ * Anki note file headers keys
825
+ *
826
+ * @see {@link https://docs.ankiweb.net/importing/text-files.html#file-headers}
827
+ */
828
+ export interface NoteHeaderKeys {
829
+ /**
830
+ * Field separator
831
+ */
832
+ readonly separator: `${string}:${string}`;
833
+ /**
834
+ * HTML treatment
835
+ */
836
+ readonly html: `${string}:${boolean}`;
837
+ /**
838
+ * GUID column header
839
+ */
840
+ readonly guid: `${string}:`;
841
+ /**
842
+ * Note type column header
843
+ */
844
+ readonly notetype: `${string}:`;
845
+ /**
846
+ * Deck name column header
847
+ */
848
+ readonly deck: `${string}:`;
849
+ /**
850
+ * Tags column header (*must be completed with a number after `:`*)
851
+ */
852
+ readonly tags: `${string}:`;
853
+ }
795
854
  /**
796
855
  * Some useful regular expressions
797
856
  */
@@ -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,GAAG,GACX,IAAI,GACJ,SAAS,GACT,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,IAAI,GACJ,MAAM,GACN,OAAO,GACP,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,MAAM,GACN,KAAK,GACL,SAAS,GACT,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,CAAC;AAEV;;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,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EACH;QACE,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,GAAG,SAAS,CAAC;QACzC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;KAChC,EAAE,GACH,SAAS,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;CACxC;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"}
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,GAAG,GACX,IAAI,GACJ,SAAS,GACT,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,IAAI,GACJ,MAAM,GACN,OAAO,GACP,KAAK,GACL,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,MAAM,GACN,KAAK,GACL,SAAS,GACT,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,CAAC;AAEV;;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,GAAG,MAAM,EAAE,CAAC;IACzB;;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,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;;;;;;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,CAAC,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,4BAA4B,EAAE,GAAG,SAAS,CAAC;IACpD;;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,SAAS,EAAE,CAAC;CACvB;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,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EACH;QACE,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,GAAG,SAAS,CAAC;QACzC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;KAChC,EAAE,GACH,SAAS,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;CACxC;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,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B;;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,EAAE,MAAM,CAAC;IACtB;;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,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACjC;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,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACjC;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;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,MAAM,GAAG,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,GAAG,MAAM,GAAG,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,MAAM,GAAG,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,MAAM,GAAG,CAAC;CAC7B;AAED;;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"}
@@ -1,5 +1,4 @@
1
- import { PollyClient, SynthesizeSpeechCommandInput } from "@aws-sdk/client-polly";
2
- import { DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, Kana, Kanji, Radical, Result, TanakaExample, Word, WordDefinitionPair } from "./types";
1
+ import { DefaultNoteInfo, Definition, DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, JaWiktionaryEntry, Kana, Kanji, Radical, Result, TanakaExample, Word, WordDefinitionPair } from "./types";
3
2
  import { ReadStream } from "fs";
4
3
  /**
5
4
  * Capitalizes a string.
@@ -30,14 +29,14 @@ export declare function isStringArray(arg: any): arg is string[];
30
29
  * @param arr The array to be shuffled
31
30
  * @returns The shuffled array
32
31
  */
33
- export declare function shuffleArray<T>(arr: T[]): T[];
32
+ export declare function shuffleArray<T>(arr: readonly T[]): T[];
34
33
  /**
35
34
  * Converts a JMdict `JMdict_e` file into an array of {@link DictWord} objects.
36
35
  * @param xmlString The raw `JMdict_e` file contents
37
36
  * @param examples An array of converted `Tanaka Corpus` examples
38
37
  * @returns An array of converted {@link DictWord} objects
39
38
  */
40
- export declare function convertJMdict(xmlString: string, examples?: TanakaExample[] | undefined): DictWord[];
39
+ export declare function convertJMdict(xmlString: string, examples?: readonly TanakaExample[] | undefined): DictWord[];
41
40
  /**
42
41
  * Converts a KANJIDIC `kanjidic2.xml` file into an array of {@link DictKanji} objects.
43
42
  * @param xmlString The raw `kanjidic2.xml` file contents
@@ -47,17 +46,22 @@ export declare function convertKanjiDic(xmlString: string): DictKanji[];
47
46
  /**
48
47
  * Converts a Tanaka Corpus `examples.utf` file into an array of {@link TanakaExample} objects.
49
48
  * @param tanakaString The raw contents of a `examples.utf` file
50
- * @param generateFurigana Whether or not to generate furigana for the phrases
51
49
  * @returns A promise resolving with an array of converted {@link TanakaExample} objects
52
50
  */
53
- export declare function convertTanakaCorpus(tanakaString: string, generateFurigana?: true): Promise<TanakaExample[]>;
51
+ export declare function convertTanakaCorpus(tanakaString: string): TanakaExample[];
52
+ /**
53
+ * Converts a Tanaka Corpus `examples.utf` file into an array of {@link TanakaExample} objects (with furigana).
54
+ * @param tanakaString The raw contents of a `examples.utf` file
55
+ * @returns A promise resolving with an array of converted {@link TanakaExample} objects (with furigana)
56
+ */
57
+ export declare function convertTanakaCorpusWithFurigana(tanakaString: string): Promise<TanakaExample[]>;
54
58
  /**
55
59
  * Converts a `radkfile2` file (EUC-JP encoded) into an array of {@link DictRadical} objects.
56
60
  * @param radkBuffer A `radkfile2` buffer
57
61
  * @param kanjiDic An array of converted `KANJIDIC` entries
58
62
  * @returns An array of converted {@link DictRadical} objects
59
63
  */
60
- export declare function convertRadkFile(radkBuffer: Buffer<ArrayBuffer>, kanjiDic: DictKanji[]): DictRadical[];
64
+ export declare function convertRadkFile(radkBuffer: Buffer<ArrayBuffer>, kanjiDic: readonly DictKanji[]): DictRadical[];
61
65
  /**
62
66
  * Converts a `kradfile2` file (EUC-JP encoded) into an array of {@link DictKanjiWithRadicals} objects.
63
67
  * @param kradBuffer A `kradfile2` buffer
@@ -65,70 +69,74 @@ export declare function convertRadkFile(radkBuffer: Buffer<ArrayBuffer>, kanjiDi
65
69
  * @param katakanaList An array of katakana {@link Kana} objects
66
70
  * @returns An array of converted {@link DictKanjiWithRadicals} objects
67
71
  */
68
- export declare function convertKradFile(kradBuffer: Buffer<ArrayBuffer>, kanjiDic: DictKanji[], katakanaList: Kana[]): DictKanjiWithRadicals[];
72
+ export declare function convertKradFile(kradBuffer: Buffer<ArrayBuffer>, kanjiDic: readonly DictKanji[], katakanaList: readonly Kana[]): DictKanjiWithRadicals[];
73
+ /**
74
+ * Converts and filters a `ja.wiktionary.org` JSONL dump (sync)
75
+ *
76
+ * 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}.
77
+ * @param buffer A JSONL dump file buffer
78
+ * @returns An array containing only the Japanese entries
79
+ */
80
+ export declare function convertJawiktionarySync(buffer: Buffer): JaWiktionaryEntry[];
69
81
  /**
70
- * Converts and filters a `ja.wiktionary.org` JSONL dump
82
+ * Converts and filters a `ja.wiktionary.org` JSONL dump (async)
71
83
  *
72
84
  * 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
- * @param stream The stream of a JSONL dump file
74
- * @returns An array containing only Japanese entries
85
+ * @param stream A JSONL dump file stream
86
+ * @returns An array containing only the Japanese entries
75
87
  */
76
- export declare function convertJawiktionary(stream: ReadStream): Promise<any[]>;
88
+ export declare function convertJawiktionaryAsync(stream: ReadStream): Promise<JaWiktionaryEntry[]>;
77
89
  /**
78
90
  * Pairs Japanese definitions with JMdict word entries
79
- * @param entryList An array containing `ja.wiktionary.org` Japanese entries (converted using {@link convertJawiktionary})
91
+ * @param entryList An array containing `ja.wiktionary.org` Japanese entries (converted using {@link convertJawiktionarySync} or {@link convertJawiktionaryAsync})
80
92
  * @param jmDict An array of converted `JMdict` entries
81
- * @param generateFurigana Whether or not to generate furigana for the definitions
82
93
  * @returns A promise resolving with an array of {@link WordDefinitionPair} objects
83
94
  */
84
- export declare function getWordDefinitions(entryList: any[], jmDict: DictWord[], generateFurigana?: true): Promise<WordDefinitionPair[]>;
95
+ export declare function getWordDefinitions(entryList: readonly JaWiktionaryEntry[], jmDict: readonly DictWord[]): WordDefinitionPair[];
96
+ /**
97
+ * Pairs Japanese definitions with JMdict word entries (with furigana)
98
+ * @param entryList An array containing `ja.wiktionary.org` Japanese entries (converted using {@link convertJawiktionarySync} or {@link convertJawiktionaryAsync})
99
+ * @param jmDict An array of converted `JMdict` entries
100
+ * @returns A promise resolving with an array of {@link WordDefinitionPair} objects (with furigana)
101
+ */
102
+ export declare function getWordDefinitionsWithFurigana(entryList: readonly JaWiktionaryEntry[], jmDict: readonly DictWord[]): Promise<WordDefinitionPair[]>;
85
103
  /**
86
- * Transforms a converted `JMdict` entry into a more readable format, by providing either its {@link id} or the {@link dictWord} object directly.
104
+ * Transforms a converted `JMdict` entry into a more readable format, by providing either its JMdict entry ID or the {@link DictWord} object directly.
105
+ * @param word The ID of the `JMdict` entry or a {@link DictWord} object
87
106
  * @param dict An array of converted `JMdict` entries
88
- * @param id The ID of the `JMdict` entry
89
- * @param kanjiDic An array of converted `KANJIDIC` entries
107
+ * @param kanjiDic An array or an ID-kanji map of converted `KANJIDIC` entries
90
108
  * @param examples An array of converted `Tanaka Corpus` examples
91
- * @param definitions An array of `ja.wiktionary.org` word definitions
92
- * @param dictWord The converted `JMdict` entry
109
+ * @param definitions An array or ID-definitions map of `ja.wiktionary.org` word definitions
93
110
  * @param noteTypeName The Anki note type name
94
111
  * @param deckPath The full Anki deck path
95
- * @returns The transformed {@link Word} object
112
+ * @returns The transformed {@link Word} object or `undefined` if entry is not found
96
113
  */
97
- export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], definitions?: WordDefinitionPair[], dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
114
+ export declare function getWord(word: `${number}` | DictWord, dict?: readonly DictWord[], kanjiDic?: readonly DictKanji[] | Map<string, readonly DictKanji[]>, examples?: readonly TanakaExample[] | Map<string, readonly TanakaExample[]>, definitions?: readonly WordDefinitionPair[] | Map<string, readonly Definition[]>, noteTypeName?: string, deckPath?: string): Word | undefined;
98
115
  /**
99
116
  * Transforms a converted `KANJIDIC` entry into a more readable format
117
+ * @param kanji The kanji character or a {@link DictKanji} object
100
118
  * @param dict An array of converted `KANJIDIC` entries
101
- * @param kanjiChar The kanji character
102
- * @param dictKanji A {@link DictKanji} object
103
- * @param jmDict An array of converted `JMdict` entries
119
+ * @param jmDict An array or a kanji-words map of converted `JMdict` entries
104
120
  * @param svgList An array of SVG file names
105
121
  * @param noteTypeName The Anki note type name
106
122
  * @param deckPath The full Anki deck path
107
- * @returns The transformed {@link Kanji} object
123
+ * @returns The transformed {@link Kanji} object or `undefined` if entry is not found
108
124
  */
109
- export declare function getKanji(dict: DictKanji[], kanjiChar?: string, dictKanji?: DictKanji, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
125
+ export declare function getKanji(kanji: string | DictKanji, dict?: readonly DictKanji[], jmDict?: readonly DictWord[] | Map<string, readonly DictWord[]>, svgList?: readonly string[], noteTypeName?: string, deckPath?: string): Kanji | undefined;
110
126
  /**
111
127
  * Same as {@link getKanji}, but with possible extra info.
112
128
  * @param info Additional info for the kanji (mnemonic, components, words)
129
+ * @param kanji The kanji character or a {@link DictKanji} object
113
130
  * @param dict An array of converted `KANJIDIC` entries
114
- * @param kanjiChar The kanji character
115
- * @param dictKanji A {@link DictKanji} object
116
131
  * @param useWords Whether or not to use the words provided in the `info` object (if present) instead of other words from `JMdict`
117
- * @param jmDict An array of converted `JMdict` entries
132
+ * @param jmDict An array or a kanji-words map of converted `JMdict` entries
118
133
  * @param svgList An array of SVG file names
119
134
  * @param noteTypeName The Anki note type name
120
135
  * @param deckPath The full Anki deck path
136
+ * @param sourceURL A link leading to the source of {@link info}
121
137
  * @returns The transformed {@link Kanji} object
122
138
  */
123
- export declare function getKanjiExtended(info: Kanji, dict: DictKanji[], kanjiChar?: string, dictKanji?: DictKanji, useWords?: true, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
124
- /**
125
- * Synthesizes text to speech audio using {@link https://aws.amazon.com/polly/ | Amazon Polly}.
126
- * @param client An Amazon Polly Client instance
127
- * @param input The input in SSML format or plain text (adjust `TextType` property in `options`)
128
- * @param options Speech generation settings
129
- * @returns A promise resolving with an audio stream buffer or with `null` if the generation failed
130
- */
131
- export declare function synthesizeSpeech(client: PollyClient, input: string, options: Omit<SynthesizeSpeechCommandInput, "Text">): Promise<Buffer<ArrayBuffer> | null>;
139
+ export declare function getKanjiExtended(info: Kanji, kanji: string | DictKanji, dict?: readonly DictKanji[], useWords?: true, jmDict?: readonly DictWord[] | Map<string, readonly DictWord[]>, svgList?: readonly string[], noteTypeName?: string, deckPath?: string, sourceURL?: string): Kanji | undefined;
132
140
  export declare function isWord(entry: Result): entry is Word;
133
141
  export declare function isRadical(entry: Result): entry is Radical;
134
142
  export declare function isKanji(entry: Result): entry is Kanji;
@@ -143,7 +151,8 @@ export declare function generateAnkiNote(entry: Result): string[];
143
151
  /**
144
152
  * Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
145
153
  * @param list An array containing any type of transformed entries ({@link Word}, {@link Kanji}, {@link Radical}, {@link Kana}, {@link Grammar})
154
+ * @param defaultNoteInfo An object with options regarding default values of some note information
146
155
  * @returns The resulting Anki notes file's content
147
156
  */
148
- export declare function generateAnkiNotesFile(list: Result[]): string;
157
+ export declare function generateAnkiNotesFile(list: readonly Result[], defaultNoteInfo?: DefaultNoteInfo | undefined): string;
149
158
  //# 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,EAEL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,EAGP,IAAI,EACJ,KAAK,EAML,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;AAyED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,SAAS,EAAE,GAAG,EAAE,EAChB,MAAM,EAAE,QAAQ,EAAE,EAClB,gBAAgB,CAAC,EAAE,IAAI,GACtB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAsrB/B;AAsCD;;;;;;;;;;;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"}
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AASA,OAAO,EACL,eAAe,EACf,UAAU,EACV,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAGX,QAAQ,EAER,OAAO,EACP,iBAAiB,EAEjB,IAAI,EACJ,KAAK,EAML,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,SAAS,CAAC,EAAE,GAAG,CAAC,EAAE,CAWtD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,GAAG,SAAS,GAC9C,QAAQ,EAAE,CAkNZ;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,CA8H9D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,EAAE,CAiFzE;AAED;;;;GAIG;AACH,wBAAsB,+BAA+B,CACnD,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,aAAa,EAAE,CAAC,CAgC1B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAC/B,QAAQ,EAAE,SAAS,SAAS,EAAE,GAC7B,WAAW,EAAE,CAqDf;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAC/B,QAAQ,EAAE,SAAS,SAAS,EAAE,EAC9B,YAAY,EAAE,SAAS,IAAI,EAAE,GAC5B,qBAAqB,EAAE,CAgEzB;AAgCD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAoB3E;AAED;;;;;;GAMG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAiC9B;AAwBD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,SAAS,iBAAiB,EAAE,EACvC,MAAM,EAAE,SAAS,QAAQ,EAAE,GAC1B,kBAAkB,EAAE,CA6oBtB;AAED;;;;;GAKG;AACH,wBAAsB,8BAA8B,CAClD,SAAS,EAAE,SAAS,iBAAiB,EAAE,EACvC,MAAM,EAAE,SAAS,QAAQ,EAAE,GAC1B,OAAO,CAAC,kBAAkB,EAAE,CAAC,CA8B/B;AAkCD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,GAAG,MAAM,EAAE,GAAG,QAAQ,EAC5B,IAAI,CAAC,EAAE,SAAS,QAAQ,EAAE,EAC1B,QAAQ,CAAC,EAAE,SAAS,SAAS,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC,EACnE,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,CAAC,EAC3E,WAAW,CAAC,EACR,SAAS,kBAAkB,EAAE,GAC7B,GAAG,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,CAAC,EACtC,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,GAAG,SAAS,CAkYlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,CAAC,EAAE,SAAS,SAAS,EAAE,EAC3B,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,CAAC,EAC/D,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,EAC3B,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,GAAG,SAAS,CAkJnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,CAAC,EAAE,SAAS,SAAS,EAAE,EAC3B,QAAQ,CAAC,EAAE,IAAI,EACf,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,CAAC,EAC/D,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,EAC3B,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,KAAK,GAAG,SAAS,CAsDnB;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAKnD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAEzD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,KAAK,CAOrD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAEnD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAEzD;AAsBD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAoVxD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,GAC5C,MAAM,CAyGR"}
@@ -6,6 +6,7 @@
6
6
 
7
7
  ## Interfaces
8
8
 
9
+ - [DefaultNoteInfo](interfaces/DefaultNoteInfo.md)
9
10
  - [Definition](interfaces/Definition.md)
10
11
  - [DictKanji](interfaces/DictKanji.md)
11
12
  - [DictKanjiForm](interfaces/DictKanjiForm.md)
@@ -28,6 +29,7 @@
28
29
  - [KanjiComponent](interfaces/KanjiComponent.md)
29
30
  - [KanjiForm](interfaces/KanjiForm.md)
30
31
  - [NoteAndTag](interfaces/NoteAndTag.md)
32
+ - [NoteHeaderKeys](interfaces/NoteHeaderKeys.md)
31
33
  - [Phrase](interfaces/Phrase.md)
32
34
  - [Radical](interfaces/Radical.md)
33
35
  - [Reading](interfaces/Reading.md)
@@ -51,20 +53,22 @@
51
53
  ## Functions
52
54
 
53
55
  - [capitalizeString](functions/capitalizeString.md)
54
- - [convertJawiktionary](functions/convertJawiktionary.md)
56
+ - [convertJawiktionaryAsync](functions/convertJawiktionaryAsync.md)
57
+ - [convertJawiktionarySync](functions/convertJawiktionarySync.md)
55
58
  - [convertJMdict](functions/convertJMdict.md)
56
59
  - [convertKanjiDic](functions/convertKanjiDic.md)
57
60
  - [convertKradFile](functions/convertKradFile.md)
58
61
  - [convertRadkFile](functions/convertRadkFile.md)
59
62
  - [convertTanakaCorpus](functions/convertTanakaCorpus.md)
63
+ - [convertTanakaCorpusWithFurigana](functions/convertTanakaCorpusWithFurigana.md)
60
64
  - [generateAnkiNote](functions/generateAnkiNote.md)
61
65
  - [generateAnkiNotesFile](functions/generateAnkiNotesFile.md)
62
66
  - [getKanji](functions/getKanji.md)
63
67
  - [getKanjiExtended](functions/getKanjiExtended.md)
64
68
  - [getWord](functions/getWord.md)
65
69
  - [getWordDefinitions](functions/getWordDefinitions.md)
70
+ - [getWordDefinitionsWithFurigana](functions/getWordDefinitionsWithFurigana.md)
66
71
  - [isStringArray](functions/isStringArray.md)
67
72
  - [isValidArray](functions/isValidArray.md)
68
73
  - [isValidArrayWithFirstElement](functions/isValidArrayWithFirstElement.md)
69
74
  - [shuffleArray](functions/shuffleArray.md)
70
- - [synthesizeSpeech](functions/synthesizeSpeech.md)
@@ -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/main/src/utils.ts#L53)
11
+ Defined in: [utils.ts:54](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L54)
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:125](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L125)
11
+ Defined in: [utils.ts:120](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L120)
12
12
 
13
13
  Converts a JMdict `JMdict_e` file into an array of [DictWord](../interfaces/DictWord.md) objects.
14
14
 
@@ -22,7 +22,7 @@ The raw `JMdict_e` file contents
22
22
 
23
23
  ### examples?
24
24
 
25
- [`TanakaExample`](../interfaces/TanakaExample.md)[]
25
+ readonly [`TanakaExample`](../interfaces/TanakaExample.md)[]
26
26
 
27
27
  An array of converted `Tanaka Corpus` examples
28
28
 
@@ -0,0 +1,29 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / convertJawiktionaryAsync
6
+
7
+ # Function: convertJawiktionaryAsync()
8
+
9
+ > **convertJawiktionaryAsync**(`stream`): `Promise`\<[`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]\>
10
+
11
+ Defined in: [utils.ts:804](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L804)
12
+
13
+ Converts and filters a `ja.wiktionary.org` JSONL dump (async)
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
+ A JSONL dump file stream
24
+
25
+ ## Returns
26
+
27
+ `Promise`\<[`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]\>
28
+
29
+ An array containing only the Japanese entries
@@ -0,0 +1,29 @@
1
+ [**henkan**](../README.md)
2
+
3
+ ***
4
+
5
+ [henkan](../README.md) / convertJawiktionarySync
6
+
7
+ # Function: convertJawiktionarySync()
8
+
9
+ > **convertJawiktionarySync**(`buffer`): [`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]
10
+
11
+ Defined in: [utils.ts:775](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L775)
12
+
13
+ Converts and filters a `ja.wiktionary.org` JSONL dump (sync)
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
+ ### buffer
20
+
21
+ `Buffer`
22
+
23
+ A JSONL dump file buffer
24
+
25
+ ## Returns
26
+
27
+ [`JaWiktionaryEntry`](../interfaces/JaWiktionaryEntry.md)[]
28
+
29
+ An array containing only the Japanese entries
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **convertKanjiDic**(`xmlString`): [`DictKanji`](../interfaces/DictKanji.md)[]
10
10
 
11
- Defined in: [utils.ts:359](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L359)
11
+ Defined in: [utils.ts:340](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L340)
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:697](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L697)
11
+ Defined in: [utils.ts:668](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L668)
12
12
 
13
13
  Converts a `kradfile2` file (EUC-JP encoded) into an array of [DictKanjiWithRadicals](../interfaces/DictKanjiWithRadicals.md) objects.
14
14
 
@@ -22,13 +22,13 @@ A `kradfile2` buffer
22
22
 
23
23
  ### kanjiDic
24
24
 
25
- [`DictKanji`](../interfaces/DictKanji.md)[]
25
+ readonly [`DictKanji`](../interfaces/DictKanji.md)[]
26
26
 
27
27
  An array of converted `KANJIDIC` entries
28
28
 
29
29
  ### katakanaList
30
30
 
31
- [`Kana`](../interfaces/Kana.md)[]
31
+ readonly [`Kana`](../interfaces/Kana.md)[]
32
32
 
33
33
  An array of katakana [Kana](../interfaces/Kana.md) objects
34
34
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **convertRadkFile**(`radkBuffer`, `kanjiDic`): [`DictRadical`](../interfaces/DictRadical.md)[]
10
10
 
11
- Defined in: [utils.ts:629](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L629)
11
+ Defined in: [utils.ts:603](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L603)
12
12
 
13
13
  Converts a `radkfile2` file (EUC-JP encoded) into an array of [DictRadical](../interfaces/DictRadical.md) objects.
14
14
 
@@ -22,7 +22,7 @@ A `radkfile2` buffer
22
22
 
23
23
  ### kanjiDic
24
24
 
25
- [`DictKanji`](../interfaces/DictKanji.md)[]
25
+ readonly [`DictKanji`](../interfaces/DictKanji.md)[]
26
26
 
27
27
  An array of converted `KANJIDIC` entries
28
28
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: convertTanakaCorpus()
8
8
 
9
- > **convertTanakaCorpus**(`tanakaString`, `generateFurigana?`): `Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
9
+ > **convertTanakaCorpus**(`tanakaString`): [`TanakaExample`](../interfaces/TanakaExample.md)[]
10
10
 
11
- Defined in: [utils.ts:501](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L501)
11
+ Defined in: [utils.ts:473](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L473)
12
12
 
13
13
  Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](../interfaces/TanakaExample.md) objects.
14
14
 
@@ -20,14 +20,8 @@ Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](..
20
20
 
21
21
  The raw contents of a `examples.utf` file
22
22
 
23
- ### generateFurigana?
24
-
25
- `true`
26
-
27
- Whether or not to generate furigana for the phrases
28
-
29
23
  ## Returns
30
24
 
31
- `Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
25
+ [`TanakaExample`](../interfaces/TanakaExample.md)[]
32
26
 
33
27
  A promise resolving with an array of converted [TanakaExample](../interfaces/TanakaExample.md) objects