fix(typings): update types for 3.0.0

BrunnerLivio · gergelyke · commit 319f66229ea4 · 2018-09-28T08:17:48.000-07:00
diff --git a/typings/express.test.ts b/typings/express.test.ts
@@ -12,7 +12,7 @@ function onHealthCheck() {
   return Promise.resolve();
 }
 
-terminus(http.createServer(app), {
+terminus.createTerminus(http.createServer(app), {
   logger: console.log,
   healthChecks: {
     "/healthcheck": () => Promise.resolve()
diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -1,12 +1,17 @@
 declare module "@godaddy/terminus" {
 
-  type HealthCheck = () => Promise<any>;
+  export type HealthCheck = () => Promise<any>;
 
-  interface HealthCheckMap {
+  export class HealthCheckError extends Error {
+    constructor(message: string, causes: any);
+    public causes: string;
+  }
+
+  export interface HealthCheckMap {
     [key: string]: HealthCheck;
   }
 
-  interface TerminusOptions {
+  export interface TerminusOptions {
     healthChecks?: HealthCheckMap;
     timeout?: number;
     signal?: string;
@@ -20,9 +25,8 @@ declare module "@godaddy/terminus" {
     onSigterm?: () => Promise<any>;
   }
 
-  type Terminus = <T>(server: T, options?: TerminusOptions) => T;
+  export type Terminus = <T>(server: T, options?: TerminusOptions) => T;
 
-  const terminus: Terminus;
+  export const createTerminus: Terminus;
 
-  export = terminus;
 }
diff --git a/typings/index.test.ts b/typings/index.test.ts
@@ -1,14 +1,14 @@
 import * as http from "http";
-import * as terminus from "@godaddy/terminus";
+import { createTerminus, HealthCheckError, HealthCheck, TerminusOptions } from "@godaddy/terminus";
 
-async function onSignal () {
+async function onSignal() {
   console.log('server is starting cleanup');
   return Promise.all([
     // your clean logic, like closing database connections
   ]);
 }
 
-async function onShutdown () {
+async function onShutdown() {
   console.log('cleanup finished, server is shutting down');
   return Promise.resolve();
 }
@@ -17,14 +17,22 @@ const server = http.createServer((request, response) => {
   response.end('<html><body><h1>Hello, World!</h1></body></html>');
 })
 
-terminus(server, {
+const healthcheck: HealthCheck = () => {
+  const status = [{ status: 'up' }];
+  const error = new HealthCheckError('Error', status);
+  throw error;
+}
+
+const options: TerminusOptions = {
   healthChecks: {
-    "/healthcheck": () => Promise.resolve()
+    "/healthcheck": healthcheck
   },
   timeout: 1000,
   onSignal,
   onShutdown,
   logger: console.log
-});
+};
+
+createTerminus(server, options);
 
 server.listen(3000);
diff --git a/typings/koa.test.ts b/typings/koa.test.ts
@@ -10,7 +10,7 @@ function onHealthCheck() {
   return Promise.resolve();
 }
 
-terminus(server, {
+terminus.createTerminus(server, {
   logger: console.log,
   healthChecks: {
     "/healthcheck": () => Promise.resolve()

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ function onHealthCheck() {`
`12`	`12`	`return Promise.resolve();`
`13`	`13`	`}`
`14`	`14`
`15`		`-terminus(http.createServer(app), {`
	`15`	`+terminus.createTerminus(http.createServer(app), {`
`16`	`16`	`logger: console.log,`
`17`	`17`	`healthChecks: {`
`18`	`18`	`"/healthcheck": () => Promise.resolve()`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ function onHealthCheck() {`
`10`	`10`	`return Promise.resolve();`
`11`	`11`	`}`
`12`	`12`
`13`		`-terminus(server, {`
	`13`	`+terminus.createTerminus(server, {`
`14`	`14`	`logger: console.log,`
`15`	`15`	`healthChecks: {`
`16`	`16`	`"/healthcheck": () => Promise.resolve()`