henkan 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +11 -10
- package/dist/index.cjs.js.map +3 -3
- package/dist/index.mjs +5 -4
- package/dist/index.mjs.map +2 -2
- package/dist/types/utils.d.ts +2 -2
- package/dist/types/utils.d.ts.map +1 -1
- package/docs/api/functions/generateAnkiNote.md +1 -1
- package/docs/api/functions/generateAnkiNotesFile.md +1 -1
- package/docs/api/functions/getKanji.md +1 -1
- package/docs/api/functions/getKanjiExtended.md +1 -1
- package/docs/api/functions/getWord.md +2 -2
- package/docs/api/functions/synthesizeSpeech.md +1 -1
- package/package.json +1 -1
package/dist/types/utils.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
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";
|
|
2
|
+
import { Definition, DictKanji, DictKanjiWithRadicals, DictRadical, DictWord, Grammar, Kana, Kanji, Radical, Result, TanakaExample, Word, WordDefinitionPair } from "./types";
|
|
3
3
|
import { ReadStream } from "fs";
|
|
4
4
|
/**
|
|
5
5
|
* Capitalizes a string.
|
|
@@ -94,7 +94,7 @@ export declare function getWordDefinitions(entryList: any[], jmDict: DictWord[],
|
|
|
94
94
|
* @param deckPath The full Anki deck path
|
|
95
95
|
* @returns The transformed {@link Word} object
|
|
96
96
|
*/
|
|
97
|
-
export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], definitions?: WordDefinitionPair[], dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
|
|
97
|
+
export declare function getWord(dict?: DictWord[], id?: string, kanjiDic?: DictKanji[], examples?: TanakaExample[], definitions?: WordDefinitionPair[] | Map<string, Definition[]>, dictWord?: DictWord, noteTypeName?: string, deckPath?: string): Word;
|
|
98
98
|
/**
|
|
99
99
|
* Transforms a converted `KANJIDIC` entry into a more readable format
|
|
100
100
|
* @param dict An array of converted `KANJIDIC` entries
|
|
@@ -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,EACL,UAAU,EACV,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,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,EAC9D,QAAQ,CAAC,EAAE,QAAQ,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAgYN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,SAAS,EAAE,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,SAAS,EACrB,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAgPP;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,SAAS,EAAE,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,SAAS,EACrB,QAAQ,CAAC,EAAE,IAAI,EACf,MAAM,CAAC,EAAE,QAAQ,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,GAChB,KAAK,CAmDP;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,GAClD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CA4BrC;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAKnD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAMzD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,KAAK,CAOrD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,IAAI,CAInD;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,CAKzD;AAsBD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CA8VxD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CA6B5D"}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **generateAnkiNote**(`entry`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2494](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2494)
|
|
12
12
|
|
|
13
13
|
Generates an array where each field holds an entry’s info wrapped in HTML tags.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **generateAnkiNotesFile**(`list`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2851](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2851)
|
|
12
12
|
|
|
13
13
|
Generates an Anki notes file with each entry’s info organized into fields, either in HTML or plain text.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getKanji**(`dict`, `kanjiChar?`, `dictKanji?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2065](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2065)
|
|
12
12
|
|
|
13
13
|
Transforms a converted `KANJIDIC` entry into a more readable format
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **getKanjiExtended**(`info`, `dict`, `kanjiChar?`, `dictKanji?`, `useWords?`, `jmDict?`, `svgList?`, `noteTypeName?`, `deckPath?`): [`Kanji`](../interfaces/Kanji.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [utils.ts:
|
|
11
|
+
Defined in: [utils.ts:2328](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2328)
|
|
12
12
|
|
|
13
13
|
Same as [getKanji](getKanji.md), but with possible extra info.
|
|
14
14
|
|
|
@@ -40,10 +40,10 @@ An array of converted `Tanaka Corpus` examples
|
|
|
40
40
|
|
|
41
41
|
### definitions?
|
|
42
42
|
|
|
43
|
-
[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[]
|
|
44
|
-
|
|
45
43
|
An array of `ja.wiktionary.org` word definitions
|
|
46
44
|
|
|
45
|
+
[`WordDefinitionPair`](../interfaces/WordDefinitionPair.md)[] | `Map`\<`string`, [`Definition`](../interfaces/Definition.md)[]\>
|
|
46
|
+
|
|
47
47
|
### dictWord?
|
|
48
48
|
|
|
49
49
|
[`DictWord`](../interfaces/DictWord.md)
|
|
@@ -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:2398](https://github.com/Ronokof/Henkan/blob/main/src/utils.ts#L2398)
|
|
12
12
|
|
|
13
13
|
Synthesizes text to speech audio using [Amazon Polly](https://aws.amazon.com/polly/).
|
|
14
14
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "henkan",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "A Node.JS library that helps you convert any dictionary from EDRDG, transform their entries into more user-friendly schemas and create Anki notes from them.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"fjsd",
|