henkan 0.0.0

package/dist/types/utils.d.ts

@@ -0,0 +1,135 @@
+import { PollyClient, SynthesizeSpeechCommandInput } from "@aws-sdk/client-polly";
+import { DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, Kana, Kanji, Radical, Result, TanakaExample, Word } from "./types";
+/**
+ * Capitalizes a string.
+ * @param value The string to capitalize
+ * @returns The capitalized string
+ */
+export declare function capitalizeString(value: string): string;
+/**
+ * Checks if the argument is an array.
+ * @param arg The argument
+ * @returns Whether or not {@link arg} is an array
+ */
+export declare function isValidArray(arg: any): arg is any[];
+/**
+ * Checks if the argument is an array and has at least one element.
+ * @param arg The argument
+ * @returns Whether or not {@link arg} is an array and has at least one element
+ */
+export declare function isValidArrayWithFirstElement(arg: any): arg is any[];
+/**
+ * Checks if the argument is an array of strings.
+ * @param arg The argument
+ * @returns Whether or not {@link arg} is an array of strings
+ */
+export declare function isStringArray(arg: any): arg is string[];
+/**
+ * Shuffles an array using the `Fisher–Yates shuffle` algorithm
+ * @param arr The array to be shuffled
+ * @returns The shuffled array
+ */
+export declare function shuffleArray<T>(arr: T[]): T[];
+/**
+ * Converts a JMdict `JMdict_e.xml`/`JMdict_e` file into an array of {@link DictWord} objects.
+ * @param xmlString The raw `JMdict_e.xml`/`JMdict_e` file contents
+ * @returns An array of converted {@link DictWord} objects
+ */
+export declare function convertJMdict(xmlString: string): DictWord[];
+/**
+ * Converts a KANJIDIC `kanjidic2.xml` file into an array of {@link DictKanji} objects.
+ * @param xmlString The raw `kanjidic2.xml` file contents
+ * @returns An array of converted {@link DictKanji} objects
+ */
+export declare function convertKanjiDic(xmlString: string): DictKanji[];
+/**
+ * Converts a Tanaka Corpus `examples.utf` file into an array of {@link TanakaExample} objects.
+ * @param tanakaString The raw contents of a `examples.utf` file
+ * @param generateFurigana Whether or not to generate furigana for the phrase
+ * @returns A promise resolving with an array of converted {@link TanakaExample} objects
+ */
+export declare function convertTanakaCorpus(tanakaString: string, generateFurigana?: true): Promise<TanakaExample[]>;
+/**
+ * Converts a `radkfile2` file into an array of {@link DictRadical} objects.
+ * @param radkBuffer A raw `radkfile2` buffer
+ * @param kanjiDic An array of converted `KANJIDIC` entries
+ * @returns An array of converted {@link DictRadical} objects
+ */
+export declare function convertRadkFile(radkBuffer: NonSharedBuffer, kanjiDic: DictKanji[]): DictRadical[];
+/**
+ * Converts a `kradfile2` file into an array of {@link DictKanjiWithRadicals} objects.
+ * @param kradBuffer A raw `kradfile2` buffer
+ * @param kanjiDic An array of converted `KANJIDIC` entries
+ * @param katakanaList An array of katakana {@link Kana} objects
+ * @returns An array of converted {@link DictKanjiWithRadicals} objects
+ */
+export declare function convertKradFile(kradBuffer: NonSharedBuffer, kanjiDic: DictKanji[], katakanaList: Kana[]): DictKanjiWithRadicals[];
+/**
+ * Transforms a converted `JMdict` entry into a more readable format, by providing either its {@link id} or the {@link dictWord} object directly.
+ * @param dict An array of converted `JMdict` entries
+ * @param id The ID of the `JMdict` entry
+ * @param kanjiDic An array of converted `KANJIDIC` entries
+ * @param examples An array of converted `Tanaka Corpus` examples
+ * @param dictWord The converted `JMdict` entry
+ * @param noteTypeName The Anki note type name
+ * @param deckPath The full Anki deck path
+ * @returns The transformed {@link Word} object
+ */
+export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
+/**
+ * Transforms a converted `KANJIDIC` entry into a more readable format
+ * @param kanjiChar The kanji character
+ * @param dict An array of converted `KANJIDIC` entries
+ * @param jmDict An array of converted `JMdict` entries
+ * @param svgList An array of SVG file names
+ * @param noteTypeName The Anki note type name
+ * @param deckPath The full Anki deck path
+ * @returns The transformed {@link Kanji} object
+ */
+export declare function getKanji(kanjiChar: string, dict: DictKanji[], jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
+/**
+ * Same as {@link getKanji}, but with possible extra info.
+ * @param kanjiChar The kanji character
+ * @param info Additional info from `jpdb.io` for the kanji (mnemonic, components, words)
+ * @param dict An array of converted `KANJIDIC` entries
+ * @param useJpdbWords Whether or not to use the `jpdb.io` provided words (if present) instead of other words from `JMdict`
+ * @param jmDict An array of converted `JMdict` entries
+ * @param svgList An array of SVG file names
+ * @param noteTypeName The Anki note type name
+ * @param deckPath The full Anki deck path
+ * @returns The transformed {@link Kanji} object
+ */
+export declare function getKanjiExtended(kanjiChar: string, info: Kanji, dict: DictKanji[], useJpdbWords?: true, jmDict?: DictWord[], svgList?: string[], noteTypeName?: string, deckPath?: string): Kanji;
+/**
+ * Builds SSML text for Japanese words
+ * @param formText The normal form of the word (usually kanji form)
+ * @param fullReading The reading of the word (hiragana or katakana)
+ * @returns The SSML text
+ */
+export declare function makeSSML(formText: string, fullReading: string): string;
+/**
+ * Synthesizes text to speech audio using {@link [Amazon Polly](https://aws.amazon.com/polly/)}.
+ * @param client An Amazon Polly Client instance
+ * @param ssmlText The text to be spoken, in SSML format
+ * @param options Other speech generation settings
+ * @returns A promise resolving with an audio stream buffer or with `null` if the generation failed
+ */
+export declare function synthesizeSpeech(client: PollyClient, ssmlText: string, options: Omit<SynthesizeSpeechCommandInput, "Text" | "TextType">): Promise<Buffer<ArrayBuffer> | null>;
+export declare function isWord(entry: Result): entry is Word;
+export declare function isRadical(entry: Result): entry is Radical;
+export declare function isKanji(entry: Result): entry is Kanji;
+export declare function isKana(entry: Result): entry is Kana;
+export declare function isGrammar(entry: Result): entry is Grammar;
+/**
+ * Generates an array where each field holds an entry’s info wrapped in HTML tags.
+ * @param entry Any type of mapped entry ({@link Word}, {@link Kanji}, {@link Radical}, {@link Kana}, {@link Grammar})
+ * @returns An array of fields, each corresponding to an Anki note type field
+ */
+export declare function generateAnkiNote(entry: Result): string[];
+/**
+ * Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
+ * @param list An array containing any type of transformed entries ({@link Word}, {@link Kanji}, {@link Radical}, {@link Kana}, {@link Grammar})
+ * @returns The resulting Anki notes file's content or `undefined` if `list` is empty
+ */
+export declare function generateAnkiNotesFile(list: Result[]): string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,WAAW,EAEX,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,SAAS,EAKT,qBAAqB,EAErB,WAAW,EAEX,QAAQ,EAER,OAAO,EACP,IAAI,EACJ,KAAK,EAIL,OAAO,EAEP,MAAM,EACN,aAAa,EAEb,IAAI,EACL,MAAM,SAAS,CAAC;AAKjB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,CAQnE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,EAAE,CAOvD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAe7C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,EAAE,CAgJ3D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,CAsH9D;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,YAAY,EAAE,MAAM,EACpB,gBAAgB,CAAC,EAAE,IAAI,GACtB,OAAO,CAAC,aAAa,EAAE,CAAC,CA0G1B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,eAAe,EAC3B,QAAQ,EAAE,SAAS,EAAE,GACpB,WAAW,EAAE,CAyDf;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,eAAe,EAC3B,QAAQ,EAAE,SAAS,EAAE,EACrB,YAAY,EAAE,IAAI,EAAE,GACnB,qBAAqB,EAAE,CAuEzB;AA+BD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,IAAI,CAAC,EAAE,QAAQ,EAAE,EACjB,EAAE,CAAC,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,SAAS,EAAE,EACtB,QAAQ,CAAC,EAAE,aAAa,EAAE,EAC1B,QAAQ,CAAC,EAAE,QAAQ,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAwPN;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,SAAS,EAAE,EACjB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAsNP;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,SAAS,EAAE,EACjB,YAAY,CAAC,EAAE,IAAI,EACnB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAqCP;AAgCD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CA4EtE;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/D,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CA6BrC;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAKnD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAMzD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,KAAK,CAOrD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAInD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAKzD;AAgBD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAmSxD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CA8BxE"}

package/docs/api/README.md

@@ -0,0 +1,62 @@
+**henkan**
+
+***
+
+# henkan
+
+## Interfaces
+
+- [DictKanji](interfaces/DictKanji.md)
+- [DictKanjiForm](interfaces/DictKanjiForm.md)
+- [DictKanjiMisc](interfaces/DictKanjiMisc.md)
+- [DictKanjiReading](interfaces/DictKanjiReading.md)
+- [DictKanjiReadingMeaning](interfaces/DictKanjiReadingMeaning.md)
+- [DictKanjiReadingMeaningGroup](interfaces/DictKanjiReadingMeaningGroup.md)
+- [DictKanjiWithRadicals](interfaces/DictKanjiWithRadicals.md)
+- [DictMeaning](interfaces/DictMeaning.md)
+- [DictRadical](interfaces/DictRadical.md)
+- [DictReading](interfaces/DictReading.md)
+- [DictWord](interfaces/DictWord.md)
+- [ExamplePart](interfaces/ExamplePart.md)
+- [Grammar](interfaces/Grammar.md)
+- [GrammarMeaning](interfaces/GrammarMeaning.md)
+- [Kana](interfaces/Kana.md)
+- [Kanji](interfaces/Kanji.md)
+- [KanjiComponent](interfaces/KanjiComponent.md)
+- [KanjiForm](interfaces/KanjiForm.md)
+- [Phrase](interfaces/Phrase.md)
+- [Radical](interfaces/Radical.md)
+- [Reading](interfaces/Reading.md)
+- [ResultEntry](interfaces/ResultEntry.md)
+- [TanakaExample](interfaces/TanakaExample.md)
+- [Translation](interfaces/Translation.md)
+- [UsefulRegExps](interfaces/UsefulRegExps.md)
+- [Word](interfaces/Word.md)
+
+## Type Aliases
+
+- [Dict](type-aliases/Dict.md)
+- [DictName](type-aliases/DictName.md)
+- [EntryType](type-aliases/EntryType.md)
+- [JLPT](type-aliases/JLPT.md)
+- [Result](type-aliases/Result.md)
+
+## Functions
+
+- [capitalizeString](functions/capitalizeString.md)
+- [convertJMdict](functions/convertJMdict.md)
+- [convertKanjiDic](functions/convertKanjiDic.md)
+- [convertKradFile](functions/convertKradFile.md)
+- [convertRadkFile](functions/convertRadkFile.md)
+- [convertTanakaCorpus](functions/convertTanakaCorpus.md)
+- [generateAnkiNote](functions/generateAnkiNote.md)
+- [generateAnkiNotesFile](functions/generateAnkiNotesFile.md)
+- [getKanji](functions/getKanji.md)
+- [getKanjiExtended](functions/getKanjiExtended.md)
+- [getWord](functions/getWord.md)
+- [isStringArray](functions/isStringArray.md)
+- [isValidArray](functions/isValidArray.md)
+- [isValidArrayWithFirstElement](functions/isValidArrayWithFirstElement.md)
+- [makeSSML](functions/makeSSML.md)
+- [shuffleArray](functions/shuffleArray.md)
+- [synthesizeSpeech](functions/synthesizeSpeech.md)

package/docs/api/functions/capitalizeString.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / capitalizeString
+
+# Function: capitalizeString()
+
+> **capitalizeString**(`value`): `string`
+
+Defined in: utils.ts:52
+
+Capitalizes a string.
+
+## Parameters
+
+### value
+
+`string`
+
+The string to capitalize
+
+## Returns
+
+`string`
+
+The capitalized string

package/docs/api/functions/convertJMdict.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertJMdict
+
+# Function: convertJMdict()
+
+> **convertJMdict**(`xmlString`): [`DictWord`](../interfaces/DictWord.md)[]
+
+Defined in: utils.ts:121
+
+Converts a JMdict `JMdict_e.xml`/`JMdict_e` file into an array of [DictWord](../interfaces/DictWord.md) objects.
+
+## Parameters
+
+### xmlString
+
+`string`
+
+The raw `JMdict_e.xml`/`JMdict_e` file contents
+
+## Returns
+
+[`DictWord`](../interfaces/DictWord.md)[]
+
+An array of converted [DictWord](../interfaces/DictWord.md) objects

package/docs/api/functions/convertKanjiDic.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertKanjiDic
+
+# Function: convertKanjiDic()
+
+> **convertKanjiDic**(`xmlString`): [`DictKanji`](../interfaces/DictKanji.md)[]
+
+Defined in: utils.ts:254
+
+Converts a KANJIDIC `kanjidic2.xml` file into an array of [DictKanji](../interfaces/DictKanji.md) objects.
+
+## Parameters
+
+### xmlString
+
+`string`
+
+The raw `kanjidic2.xml` file contents
+
+## Returns
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted [DictKanji](../interfaces/DictKanji.md) objects

package/docs/api/functions/convertKradFile.md

@@ -0,0 +1,39 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertKradFile
+
+# Function: convertKradFile()
+
+> **convertKradFile**(`kradBuffer`, `kanjiDic`, `katakanaList`): [`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
+
+Defined in: utils.ts:552
+
+Converts a `kradfile2` file into an array of [DictKanjiWithRadicals](../interfaces/DictKanjiWithRadicals.md) objects.
+
+## Parameters
+
+### kradBuffer
+
+`NonSharedBuffer`
+
+A raw `kradfile2` buffer
+
+### kanjiDic
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted `KANJIDIC` entries
+
+### katakanaList
+
+[`Kana`](../interfaces/Kana.md)[]
+
+An array of katakana [Kana](../interfaces/Kana.md) objects
+
+## Returns
+
+[`DictKanjiWithRadicals`](../interfaces/DictKanjiWithRadicals.md)[]
+
+An array of converted [DictKanjiWithRadicals](../interfaces/DictKanjiWithRadicals.md) objects

package/docs/api/functions/convertRadkFile.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertRadkFile
+
+# Function: convertRadkFile()
+
+> **convertRadkFile**(`radkBuffer`, `kanjiDic`): [`DictRadical`](../interfaces/DictRadical.md)[]
+
+Defined in: utils.ts:487
+
+Converts a `radkfile2` file into an array of [DictRadical](../interfaces/DictRadical.md) objects.
+
+## Parameters
+
+### radkBuffer
+
+`NonSharedBuffer`
+
+A raw `radkfile2` buffer
+
+### kanjiDic
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted `KANJIDIC` entries
+
+## Returns
+
+[`DictRadical`](../interfaces/DictRadical.md)[]
+
+An array of converted [DictRadical](../interfaces/DictRadical.md) objects

package/docs/api/functions/convertTanakaCorpus.md

@@ -0,0 +1,33 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / convertTanakaCorpus
+
+# Function: convertTanakaCorpus()
+
+> **convertTanakaCorpus**(`tanakaString`, `generateFurigana?`): `Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
+
+Defined in: utils.ts:370
+
+Converts a Tanaka Corpus `examples.utf` file into an array of [TanakaExample](../interfaces/TanakaExample.md) objects.
+
+## Parameters
+
+### tanakaString
+
+`string`
+
+The raw contents of a `examples.utf` file
+
+### generateFurigana?
+
+`true`
+
+Whether or not to generate furigana for the phrase
+
+## Returns
+
+`Promise`\<[`TanakaExample`](../interfaces/TanakaExample.md)[]\>
+
+A promise resolving with an array of converted [TanakaExample](../interfaces/TanakaExample.md) objects

package/docs/api/functions/generateAnkiNote.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / generateAnkiNote
+
+# Function: generateAnkiNote()
+
+> **generateAnkiNote**(`entry`): `string`[]
+
+Defined in: utils.ts:1422
+
+Generates an array where each field holds an entry’s info wrapped in HTML tags.
+
+## Parameters
+
+### entry
+
+[`Result`](../type-aliases/Result.md)
+
+Any type of mapped entry ([Word](../interfaces/Word.md), [Kanji](../interfaces/Kanji.md), [Radical](../interfaces/Radical.md), [Kana](../interfaces/Kana.md), [Grammar](../interfaces/Grammar.md))
+
+## Returns
+
+`string`[]
+
+An array of fields, each corresponding to an Anki note type field

package/docs/api/functions/generateAnkiNotesFile.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / generateAnkiNotesFile
+
+# Function: generateAnkiNotesFile()
+
+> **generateAnkiNotesFile**(`list`): `undefined` \| `string`
+
+Defined in: utils.ts:1720
+
+Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
+
+## Parameters
+
+### list
+
+[`Result`](../type-aliases/Result.md)[]
+
+An array containing any type of transformed entries ([Word](../interfaces/Word.md), [Kanji](../interfaces/Kanji.md), [Radical](../interfaces/Radical.md), [Kana](../interfaces/Kana.md), [Grammar](../interfaces/Grammar.md))
+
+## Returns
+
+`undefined` \| `string`
+
+The resulting Anki notes file's content or `undefined` if `list` is empty

package/docs/api/functions/getKanji.md

@@ -0,0 +1,57 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / getKanji
+
+# Function: getKanji()
+
+> **getKanji**(`kanjiChar`, `dict`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
+
+Defined in: utils.ts:927
+
+Transforms a converted `KANJIDIC` entry into a more readable format
+
+## Parameters
+
+### kanjiChar
+
+`string`
+
+The kanji character
+
+### dict
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted `KANJIDIC` entries
+
+### jmDict?
+
+[`DictWord`](../interfaces/DictWord.md)[]
+
+An array of converted `JMdict` entries
+
+### svgList?
+
+`string`[]
+
+An array of SVG file names
+
+### noteTypeName?
+
+`string`
+
+The Anki note type name
+
+### deckPath?
+
+`string`
+
+The full Anki deck path
+
+## Returns
+
+[`Kanji`](../interfaces/Kanji.md)
+
+The transformed [Kanji](../interfaces/Kanji.md) object

package/docs/api/functions/getKanjiExtended.md

@@ -0,0 +1,69 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / getKanjiExtended
+
+# Function: getKanjiExtended()
+
+> **getKanjiExtended**(`kanjiChar`, `info`, `dict`, `useJpdbWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
+
+Defined in: utils.ts:1162
+
+Same as [getKanji](getKanji.md), but with possible extra info.
+
+## Parameters
+
+### kanjiChar
+
+`string`
+
+The kanji character
+
+### info
+
+[`Kanji`](../interfaces/Kanji.md)
+
+Additional info from `jpdb.io` for the kanji (mnemonic, components, words)
+
+### dict
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted `KANJIDIC` entries
+
+### useJpdbWords?
+
+`true`
+
+Whether or not to use the `jpdb.io` provided words (if present) instead of other words from `JMdict`
+
+### jmDict?
+
+[`DictWord`](../interfaces/DictWord.md)[]
+
+An array of converted `JMdict` entries
+
+### svgList?
+
+`string`[]
+
+An array of SVG file names
+
+### noteTypeName?
+
+`string`
+
+The Anki note type name
+
+### deckPath?
+
+`string`
+
+The full Anki deck path
+
+## Returns
+
+[`Kanji`](../interfaces/Kanji.md)
+
+The transformed [Kanji](../interfaces/Kanji.md) object

package/docs/api/functions/getWord.md

@@ -0,0 +1,63 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / getWord
+
+# Function: getWord()
+
+> **getWord**(`dict?`, `id?`, `kanjiDic?`, `examples?`, `dictWord?`, `noteTypeName?`, `deckPath?`): [`Word`](../interfaces/Word.md)
+
+Defined in: utils.ts:659
+
+Transforms a converted `JMdict` entry into a more readable format, by providing either its [id](#getword) or the [dictWord](#getword) object directly.
+
+## Parameters
+
+### dict?
+
+[`DictWord`](../interfaces/DictWord.md)[]
+
+An array of converted `JMdict` entries
+
+### id?
+
+`string`
+
+The ID of the `JMdict` entry
+
+### kanjiDic?
+
+[`DictKanji`](../interfaces/DictKanji.md)[]
+
+An array of converted `KANJIDIC` entries
+
+### examples?
+
+[`TanakaExample`](../interfaces/TanakaExample.md)[]
+
+An array of converted `Tanaka Corpus` examples
+
+### dictWord?
+
+[`DictWord`](../interfaces/DictWord.md)
+
+The converted `JMdict` entry
+
+### noteTypeName?
+
+`string`
+
+The Anki note type name
+
+### deckPath?
+
+`string`
+
+The full Anki deck path
+
+## Returns
+
+[`Word`](../interfaces/Word.md)
+
+The transformed [Word](../interfaces/Word.md) object

package/docs/api/functions/isStringArray.md

@@ -0,0 +1,27 @@
+[**henkan**](../README.md)
+
+***
+
+[henkan](../README.md) / isStringArray
+
+# Function: isStringArray()
+
+> **isStringArray**(`arg`): `arg is string[]`
+
+Defined in: utils.ts:85
+
+Checks if the argument is an array of strings.
+
+## Parameters
+
+### arg
+
+`any`
+
+The argument
+
+## Returns
+
+`arg is string[]`
+
+Whether or not [arg](#isstringarray) is an array of strings