🔌 get-port-please

Get an available TCP port to listen

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![JSDocs][jsdocs-src]][jsdocs-href]

Usage

Install package:

``bash
npm i get-port-please
`

`js
// ESM
import {
getPort,
checkPort,
getRandomPort,
waitForPort,
getSocketAddress,
isSocketSupported,
cleanSocket
} from "get-port-please";

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

`
getPort(options: GetPortOptions): Promise;
checkPort(port: number, host?: string): Promise
waitForPort(port: number, options): Promise
`

Try sequence is: port > ports > random

Options

`ts
interface GetPortOptions {
name?: string;

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

memoDir?: string;
memoName?: string;
}
`

$3

Unique name for port memorizing. Default is default.

$3

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

$3

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

$3

Extended ports to check.

$3

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.

$3

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).

$3

The host to check. Default is process.env.HOST` otherwise all available hosts will be checked.

License

MIT

[npm-version-src]: https://img.shields.io/npm/v/get-port-please?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/get-port-please
[npm-downloads-src]: https://img.shields.io/npm/dm/get-port-please?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/get-port-please
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/get-port-please/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/unjs/get-port-please
[license-src]: https://img.shields.io/github/license/unjs/get-port-please.svg?style=flat&colorA=18181B&colorB=F0DB4F
[license-href]: https://github.com/unjs/get-port-please/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
[jsdocs-href]: https://www.jsdocs.io/package/get-port-please