From 5461980ffd346f382a92c062c6b28883443c13d5 Mon Sep 17 00:00:00 2001 From: ALOHACREPES345 Date: Sun, 20 Feb 2022 15:57:39 +0900 Subject: [PATCH] add types --- package.json | 3 ++- src/index.d.ts | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 src/index.d.ts diff --git a/package.json b/package.json index 07f82a5..38d8ebf 100644 --- a/package.json +++ b/package.json @@ -95,5 +95,6 @@ "lint-staged": { "src/**/*.js": "eslint", "test/**/*.js": "eslint" - } + }, + "types": "./src/index.d.ts" } diff --git a/src/index.d.ts b/src/index.d.ts new file mode 100644 index 0000000..1728d16 --- /dev/null +++ b/src/index.d.ts @@ -0,0 +1,38 @@ +// to avoid mistakenly treating d.ts as js by ESLint. +/* eslint-disable */ +declare class Kuroshiro { + constructor(); + init(_analyzer: any): Promise; + convert( + str: string, + options?: { + to?: string; + mode?: string; + romajiSystem?: string; + delimiter_start?: string; + delimiter_end?: string; + } + ): Promise; + Util: { + isHiragana: (ch: string) => boolean; + isKatakana: (ch: string) => boolean; + isKana: (ch: string) => boolean; + isKanji: (ch: string) => boolean; + isJapanese: (ch: string) => boolean; + hasHiragana: (str: string) => boolean; + hasKatakana: (str: string) => boolean; + hasKana: (str: string) => boolean; + hasKanji: (str: string) => boolean; + hasJapanese: (str: string) => boolean; + kanaToHiragana: (str: string) => string; + kanaToKatakana: (str: string) => string; + kanaToRomaji: ( + str: string, + system: "nippon" | "passport" | "hepburn" + ) => string; + }; +} + +declare module "kuroshiro" { + export = Kuroshiro; +}