line_push/node_modules/get-port-please/dist/index.d.ts
2022-07-18 02:50:52 +00:00

28 lines
1.0 KiB
TypeScript

declare function isUnsafePort(port: number): boolean;
declare function isSafePort(port: number): boolean;
interface GetPortOptions {
name: string;
random: boolean;
port: number;
ports: number[];
portRange: [from: number, to: number];
host: string;
memoDir: string;
memoName: string;
}
declare type GetPortInput = Partial<GetPortOptions> | number | string;
declare type HostAddress = undefined | string;
declare type PortNumber = number;
declare function getPort(config?: GetPortInput): Promise<PortNumber>;
declare function getRandomPort(host?: HostAddress): Promise<number>;
interface WaitForPortOptions {
host?: HostAddress;
delay?: number;
retries?: number;
}
declare function waitForPort(port: PortNumber, opts?: WaitForPortOptions): Promise<void>;
declare function checkPort(port: PortNumber, host?: HostAddress | HostAddress[]): Promise<PortNumber | false>;
export { GetPortInput, GetPortOptions, HostAddress, PortNumber, WaitForPortOptions, checkPort, getPort, getRandomPort, isSafePort, isUnsafePort, waitForPort };