portfinder

Install

npm i portfinder

yarn add portfinder

pnpm add portfinder

A simple tool to find an open port on the current machine

let basePort: number;

let highestPort: number;

getPort: {
    (callback: PortfinderCallback): void;
    (options: PortFinderOptions, callback: PortfinderCallback): void;
};

getPortPromise: (options?: PortFinderOptions) => Promise<number>;

getPorts: (
    count: number,
    options: PortFinderOptions,
    callback: (err: Error, ports: Array<number>) => void
) => void;

setBasePort: (port: number) => void;

setHighestPort: (port: number) => void;

interface PortFinderOptions {}

host?: string;

port?: number;

startPort?: number;

search start port (equals to port when not provided) This exists because getPort and getPortPromise mutates port state in recursive calls and doesn't have a way to retrieve begininng port while searching.

stopPort?: number;

type PortfinderCallback = (err: Error, port: number) => void;

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/portfinder.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/portfinder)

HTML

<a href="https://www.jsdocs.io/package/portfinder"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>