Merge pull request #39 from Simon-Tang/types

Adds TypeScript type declarations

package.json

@@ -6,6 +6,7 @@
   "private": false,
   "main": "dist/samjs.min.js",
   "module": "dist/samjs.esm.min.js",
+  "types": "src/index.d.ts",
   "scripts": {
     "dev": "rollup -w -c build/config.js --environment TARGET:dev",
     "dev:cjs": "rollup -w -c build/config.js --environment TARGET:cjs",

src/index.d.ts

@@ -0,0 +1,25 @@
+interface SamJsOptions {
+  phonetic?: boolean;
+  singmode?: boolean;
+  debug?: boolean;
+  pitch?: number;
+  speed?: number;
+  mouth?: number;
+  throat?: number;
+}
+
+interface SamJsSpeakPromise extends Promise<true> {
+  abort: (reason: any) => void;
+}
+
+declare class SamJs {
+  constructor(options?: SamJsOptions);
+  buf8(text: string, phonetic?: boolean): Uint8Array | Boolean;
+  buf32(text: string, phonetic?: boolean): Float32Array | Boolean;
+  speak(text: string, phonetic?: boolean): SamJsSpeakPromise;
+  download(text: string, phonetic?: boolean): void;
+}
+
+declare module "sam-js" {
+  export = SamJs;
+}