Merge pull request #9 from paulblyth/feat/add-typings

Added typings

package.json

@@ -17,6 +17,7 @@
     "promise"
   ],
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "build": "./scripts/build.js",
     "build:watch": "npm run build -- --watch",

scripts/build.js

@@ -56,6 +56,8 @@ const build = () => {
       }
     ], () => { console.log('Build complete.')});
   });
+
+  fs.createReadStream('./src/index.d.ts').pipe(fs.createWriteStream('./lib/index.d.ts'));
 };
 
 if (argv.watch) {

src/index.d.ts

@@ -0,0 +1,40 @@
+declare namespace Penpal {
+
+    interface IConnectionObject {
+        promise: Promise<any>;
+        destroy: () => {};
+    }
+
+    interface IChildConnectionObject extends IConnectionObject {
+        iframe: HTMLElement;
+    }
+
+    type ConnectionMethods<T> = {
+        [P in keyof T]: () => Promise<any>;
+    };
+
+    interface IConnectionOptions {
+        methods?: ConnectionMethods<{}>;
+    }
+
+    interface IChildConnectionOptions extends IConnectionOptions {
+        appendTo?: HTMLElement;
+        url: string;
+    }
+
+    interface IParentConnectionOptions extends IConnectionOptions {
+        parentOrigin?: string[] | string;
+    }
+
+    interface PenpalStatic {
+        connectToChild(options: IChildConnectionOptions): IChildConnectionObject;
+        connectToParent(options?: IParentConnectionOptions): IConnectionObject;
+        Promise: typeof Promise;
+        debug: Boolean;
+    }
+}
+
+declare module 'penpal' {
+    const Penpal: Penpal.PenpalStatic;
+    export = Penpal;
+}