feat(types): add typescript support

remojansen · gergelyke · commit 4b731fadede2 · 2017-12-18T07:48:51.000-08:00
diff --git a/package.json b/package.json
@@ -3,8 +3,10 @@
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
+  "types": "./typings/index.d.ts",
   "scripts": {
-    "test": "mocha lib/**/*.spec.js",
+    "test-typings": "tsc --lib ES2015 --noEmit typings/*.ts",
+    "test": "mocha lib/**/*.spec.js && npm run test-typings",
     "eslint": "eslint-godaddy -c .eslintrc lib example index.js",
     "coverage": "nyc mocha lib/**/*.spec.js",
     "publish": "npm run eslint && npm test",
@@ -22,6 +24,9 @@
     "stoppable": "^1.0.5"
   },
   "devDependencies": {
+    "@types/express": "^4.0.39",
+    "@types/koa": "^2.0.42",
+    "@types/node": "^8.0.58",
     "chai": "^4.1.2",
     "eslint": "^4.4.1",
     "eslint-config-godaddy": "^2.0.0",
@@ -31,7 +36,8 @@
     "mocha": "^4.0.1",
     "node-fetch": "^1.7.3",
     "nyc": "^11.3.0",
+    "semantic-release": "^8.2.0",
     "supertest": "^3.0.0",
-    "semantic-release": "^8.2.0"
+    "typescript": "^2.6.2"
   }
 }
diff --git a/typings/express.test.ts b/typings/express.test.ts
@@ -0,0 +1,20 @@
+import * as http from "http";
+import * as terminus from "@godaddy/terminus";
+import * as express from "express";
+
+const app = express();
+
+app.get("/", (req, res) => res.send("ok"));
+
+const server = http.createServer(app);
+  
+function onHealthCheck() {
+  return Promise.resolve();
+}
+
+terminus(http.createServer(app), {
+  logger: console.log,
+  healthChecks: {
+    "/healthcheck": () => Promise.resolve()
+  }
+}).listen(3000);
diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -0,0 +1,22 @@
+declare module "@godaddy/terminus" {
+
+   type HealthCheck = () => Promise<any>;
+
+  interface HealthCheckMap {
+    [key: string]: HealthCheck;
+  }
+
+  interface TerminusOptions {
+    healthChecks?: HealthCheckMap;
+    timeout?: number;
+    onSigterm?: () => Promise<any>;
+    onShutdown?: () => Promise<any>;
+    logger?: (msg: string, err: Error) => void;
+  }
+
+  type Terminus = <T>(server: T, options?: TerminusOptions) => T;
+
+  const terminus: Terminus;
+
+  export = terminus;
+}
diff --git a/typings/index.test.ts b/typings/index.test.ts
@@ -0,0 +1,30 @@
+import * as http from "http";
+import * as terminus from "@godaddy/terminus";
+
+async function onSigterm () {
+  console.log('server is starting cleanup');
+  return Promise.all([
+    // your clean logic, like closing database connections
+  ]);
+}
+
+async function onShutdown () {
+  console.log('cleanup finished, server is shutting down');
+  return Promise.resolve();
+}
+
+const server = http.createServer((request, response) => {
+  response.end('<html><body><h1>Hello, World!</h1></body></html>');
+})
+
+terminus(server, {
+  healthChecks: {
+    "/healthcheck": () => Promise.resolve()
+  },
+  timeout: 1000,
+  onSigterm,
+  onShutdown,
+  logger: console.log
+});
+
+server.listen(3000);
diff --git a/typings/koa.test.ts b/typings/koa.test.ts
@@ -0,0 +1,20 @@
+import * as http from "http";
+import * as terminus from "@godaddy/terminus";
+import * as Koa from "koa";
+
+const app = new Koa();
+
+const server = http.createServer(app.callback());
+
+function onHealthCheck() {
+  return Promise.resolve();
+}
+
+terminus(server, {
+  logger: console.log,
+  healthChecks: {
+    "/healthcheck": () => Promise.resolve()
+  }
+});
+
+server.listen(3000);
