Install

npm install get-port-please

yarn add get-port-please

🔌 get-port-please

Get an available TCP port to listen

Usage

Install package:

 npm i get-port-please

 // ESM
import {
  getPort,
  checkPort,
  getRandomPort,
  waitForPort,
} from "get-port-please";

// CommonJS
const {
  getPort,
  checkPort,
  getRandomPort,
  waitForPort,
} = require("get-port-please");

 getPort(options?: GetPortOptions): Promise<number>
checkPort(port: number, host?: string): Promise<number | false>
waitForPort(port: number, options): Promise<number | false>

Try sequence is: port > ports > random

Options

 interface GetPortOptions {
  name?: string;

  random?: boolean;
  port?: number;
  portRange?: [fromInclusive: number, toInclusive: number];
  ports?: number[];
  host?: string;

  memoDir?: string;
  memoName?: string;
}

`name`

Unique name for port memorizing. Default is default.

`random`

If enabled, port and ports will be ignored. Default is false.

`port`

First port to check. Default is process.env.PORT || 3000

`ports`

Extended ports to check.

`portRange`

Extended port range to check.

The range's start and end are inclusive, i.e. it is [start, end] in the mathematical notion.
Reversed port ranges are not supported. If start > end, then an empty range will be returned.

`alternativePortRange`

Alternative port range to check as fallback when none of the ports are available.

The range's start and end are inclusive, i.e. it is [start, end] in the mathematical notion.
Reversed port ranges are not supported. If start > end, then an empty range will be returned.

The default range is [3000, 3100] (only when port is unspecified).