http-terminator/src/types.ts

Gracefully terminates HTTP(S) server.

import type {
  Server as HttpServer,
} from 'http';
import type {
  Http2SecureServer,
} from 'http2';
import type {
  Server as HttpsServer,
} from 'https';
import type {
  Duplex,
} from 'stream';
import type {
  Merge,
} from 'type-fest';

/**
 * @property gracefulTerminationTimeout Number of milliseconds to allow for the active sockets to complete serving the response (default: 5000).
 * @property server Instance of http.Server.
 */
export type HttpTerminatorConfigurationInput = {
  readonly gracefulTerminationTimeout?: number,
  readonly server: Http2SecureServer | HttpServer | HttpsServer,
};

/**
 * @property terminate Terminates HTTP server.
 */
export type HttpTerminator = {
  readonly terminate: () => Promise<void>,
};

export type InternalHttpTerminator = Merge<HttpTerminator, {
  readonly secureSockets: Set<Duplex>,
  readonly sockets: Set<Duplex>,
}>;