Added types

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "Taiwanese Hokkien Transliterator and Tokeniser",
   "main": "taibun/index.js",
+  "types": "taibun/index.d.ts",
   "scripts": {
     "test": "jest"
   },

taibun/index.d.ts

@@ -0,0 +1,23 @@
+interface ConverterOptions {
+    system?: 'Tailo' | 'POJ' | 'Zhuyin' | 'TLPA' | 'Pingyim' | 'Tongiong' | 'IPA';
+    dialect?: 'south' | 'north';
+    format?: 'mark' | 'number' | 'strip';
+    delimiter?: string;
+    sandhi?: 'auto' | 'none' | 'excLast' | 'inclLast';
+    punctuation?: 'format' | 'none';
+    convertNonCjk?: boolean;
+}
+
+export class Converter {
+    constructor(options?: ConverterOptions);
+    get(input: string): string;
+}
+
+export class Tokeniser {
+    constructor();
+    tokenise(input: string): string[];
+}
+
+export function isCjk(input: string): boolean;
+export function toTraditional(input: string): string;
+export function toSimplified(input: string): string;