@ladjs/graceful/index.d.ts

Gracefully exit HTTP servers (Express/Koa/Fastify/etc), databases (Mongo/Mongoose), Bree job schedulers, and custom handlers.

type Logger = {
  info(...args: unknown[]): unknown;
  warn(...args: unknown[]): unknown;
  error(...args: unknown[]): unknown;
};

type LilHttpTerminator = {
  gracefulTerminationTimeout?: number;
  maxWaitTimeout?: number;
  logger?: Logger;
};

export type GracefulOptions = {
  servers?: Array<{ close(): unknown }>;
  brees?: Array<{ stop(): Promise<void> }>;
  redisClients?: Array<{ disconnect(): unknown }>;
  mongooses?: Array<{ disconnect(): Promise<void> }>;
  customHandlers?: Array<() => unknown>;
  logger?: Logger;
  timeoutMs?: number;
  lilHttpTerminator?: LilHttpTerminator;
  ignoreHook?: string | boolean;
};

export default class Graceful {
  constructor(options?: GracefulOptions);
  listen(): void;
  exit(code: number | string): Promise<void>;
}