diff --git a/types/lightship/index.d.ts b/types/lightship/index.d.ts new file mode 100644 index 0000000000..f4a30fda74 --- /dev/null +++ b/types/lightship/index.d.ts @@ -0,0 +1,43 @@ +// Type definitions for lightship 3.0 +// Project: https://github.com/gajus/lightship#readme +// Definitions by: Scott Chang +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +/// + +/** + * A teardown function called when shutdown is initialized. + * @param userConfiguration User configuration object + */ +export function createLightship(userConfiguration?: UserConfigurationType): LightshipType; + +export interface UserConfigurationType { + /* Run Iapetus only if service is detected ro be running in Kubernetes. Default: true. */ + detectKubernetes?: boolean; + /* The port on which the Lightship service listens. This port must be different than your main service port, if any. The default port is 9000.*/ + port?: number; + /* An a array of [signal events]{@link https://nodejs.org/api/process.html#process_signal_events}. Default: [SIGTERM]. */ + signals?: ReadonlyArray; + /* A number of milliseconds before force full termination. Default: 60000. */ + timeout?: number; +} + +export interface LightshipType { + /* Checks if server is in SERVER_IS_READY state */ + isServerReady: () => boolean; + /* Checks if server is in SERVER_IS_SHUTTING_DOWN state */ + isServerShuttingDown: () => boolean; + /** + * Registers teardown functions that are called when shutdown is initialized. + * All registered shutdown handlers are executed in the order they have been registered. + * After all shutdown handlers have been executed, Lightship asks `process.exit()` to terminate the process synchronously. + */ + registerShutdownHandler: (shutdownHandler: ShutdownHandlerType) => void; + /* Changes server state to SERVER_IS_SHUTTING_DOWN and initialises the shutdown of the application.*/ + shutdown: () => Promise; + /* Changes server state to SERVER_IS_NOT_READY. */ + signalNotReady: () => void; + /* Changes server state to SERVER_IS_READY. */ + signalReady: () => void; +} + +export type ShutdownHandlerType = () => Promise | void; diff --git a/types/lightship/lightship-tests.ts b/types/lightship/lightship-tests.ts new file mode 100644 index 0000000000..11d8d35100 --- /dev/null +++ b/types/lightship/lightship-tests.ts @@ -0,0 +1,17 @@ +import { createLightship, UserConfigurationType, LightshipType } from 'lightship'; + +const lightshipParams: UserConfigurationType = { + detectKubernetes: false, + timeout: 1000, + port: 50, + signals: ['SIGBUS'] +}; + +const lightship: LightshipType = createLightship(lightshipParams); + +lightship.isServerReady(); // $ExpectType boolean +lightship.isServerShuttingDown(); // $ExpectType boolean +lightship.registerShutdownHandler(() => {}); // $ExpectType void +lightship.shutdown(); // $ExpectType Promise +lightship.signalNotReady(); // $ExpectType void +lightship.signalReady(); // $ExpectType void diff --git a/types/lightship/tsconfig.json b/types/lightship/tsconfig.json new file mode 100644 index 0000000000..f28d94a99f --- /dev/null +++ b/types/lightship/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "lightship-tests.ts" + ] +} diff --git a/types/lightship/tslint.json b/types/lightship/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/lightship/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }