omniwheel/dist/server-promises.d.ts

Boilerplate reduction for backend and microservices. Scale your application easily in any direction.

/// <reference types="node" />
import EventEmitter from 'node:events';
interface Listenable<ServerType extends EventEmitter> {
    listen: ((port: number, hostname: string, callback?: () => void) => ServerType) & ((port: number, callback?: () => void) => ServerType) & ((callback?: () => void) => ServerType);
}
interface Closable extends EventEmitter {
    close: (cb: (err?: Error) => void) => any;
}
/**
 * Invoke the object's callback-based listen() method, returning a Promise to the created server.
 * The Promise is resolved only as soon as the server is listening, as indicated by its 'listening' event.
 *
 * This function can be used to start Express applications, but also regular http.Server instances etc.,
 * as long as they have a compatible listen() method.
 *
 * @param app The application to start.
 * @param port The port to listen on.
 * @param hostname The hostname to listen on.
 * @returns A Promise that resolves to the started server.
 */
export declare function promisifiedListen<ServerType extends EventEmitter>(app: Listenable<ServerType>, port: number, hostname?: string): Promise<ServerType>;
/**
 * Invoke the object's callback-based close() method, returning a Promise.
 *
 * This is intended to stop http.Server instances but can be used for anything with a compatible close() method.
 *
 * @param server The server to close.
 * @returns A Promise that resolves when done.
 */
export declare function promisifiedClose(server: Closable): Promise<void>;
export {};