add d.ts to support typescript (#14)

support typescript types
creeperyang · Jun 21, 2018 · c6b3ba9 · c6b3ba9
1 parent e8eab40
commit c6b3ba9
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/tiny-pinyin.d.ts b/tiny-pinyin.d.ts
@@ -0,0 +1,26 @@
+declare namespace TinyPinyin {
+  interface DICT {
+    PINYINS: string[]
+    UNIHANS: string[]
+    EXCEPTIONS: {
+      [code: string]: string
+    }
+  }
+  interface Patcher {
+    (DICT: DICT): void
+  }
+  export function isSupported(force?: boolean): boolean
+  export function parse(
+    str: string
+  ): {
+    type: 1 | 2 | 3
+    source: string
+    target: string
+  }[]
+  export function convertToPinyin(str: string, separator?: string, lowerCase?: boolean): string
+  export function patchDict(patcher: Patcher | Patcher[]): void
+}
+
+declare module 'tiny-pinyin' {
+  export = TinyPinyin
+}