Merge pull request #4 from krakenjs/typescript-def

chore: add typescript definition

index.d.ts

@@ -0,0 +1,11 @@
+import express from 'express';
+
+export interface AppServerType {
+  EVENT: { SHUTDOWN: 'shutdown' };
+  close: () => Promise<void>;
+  on: (event: string, handler: () => void) => { cancel: () => void; } ;
+  listen: (options: {port: number}) => Promise<AppServerType>;
+  get: (url: string, handler: (req: express.Request, res: express.Response) => Promise<void> | void) => AppServerType;
+}
+
+export function server(): AppServerType;

index.test-d.ts

@@ -0,0 +1,6 @@
+import { expectType } from 'tsd';
+
+import {AppServerType, server} from '.';
+
+
+const appServer: AppServerType = server();

package.json

@@ -3,16 +3,17 @@
   "version": "1.0.10",
   "description": "Express with promises",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "flow-typed": "flow-typed install",
     "flow:build": "flow gen-flow-files ./src/index.js --out-dir ./src",
     "babel": "babel src/*.js src/**/*.js --exclude=node_modules --out-dir . --source-maps inline",
-    "test": "npm run flow-typed && npm run lint && npm run flow-typed && npm run flow",
+    "test": "npm run flow-typed && npm run lint && npm run flow && npm run tsd",
+    "tsd": "tsd",
     "flow": "flow",
     "lint": "eslint src/ *.js",
     "prepublish": "in-publish && npm run babel || not-in-publish",
-    "postpublish": "git checkout ./src",
-    "jest": "jest test --env=node --no-cache --coverage --verbose --runInBand"
+    "postpublish": "git checkout ./src"
   },
   "repository": {
     "type": "git",
@@ -30,9 +31,10 @@
   },
   "homepage": "https://github.com/krakenjs/subprocess-robot#readme",
   "devDependencies": {
+    "@types/express": "^4.17.13",
     "flow-bin": "^0.69.0",
     "grumbler-scripts": "^2.0.7",
-    "jest": "^22.4.3",
+    "tsd": "^0.19.1",
     "yargs-parser": "^10.0.0"
   },
   "peerDependencies": {

src/express.js

@@ -2,7 +2,7 @@
 
 import https from 'https';
 
-import express from 'express';
+import express from 'express'; // eslint-disable-line import/no-unresolved
 
 type ExpressRequest = express$Request; // eslint-disable-line no-undef
 type ExpressResponse = express$Response; // eslint-disable-line no-undef