get-port-please

Get an available TCP port to listen

Usage no npm install needed!

<script type="module">
  import getPortPlease from 'https://cdn.skypack.dev/get-port-please';
</script>

README

get-port-please

get-port-please

Get an available TCP port to listen

npm npm (scoped with tag)

Usage

Install package:

yarn add get-port-please
# or
or npm install get-port-please

const { getPort, checkPort } = require('get-port-please')
// or
import { getPort, checkPort } from 'get-port-please'

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

Try sequence is: port > ports > memo > random

Options

interface GetPortOptions {
  name?: string

  random?: boolean
  port?: 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

Alternative ports to check. Default is [4000, 5000, 6000, 7000]

host

The host to check. Default is process.env.HOST || '0.0.0.0'

memoDir / memoName

Options passed to fs-memo

  • Default dir: node_modules/get-port/dist
  • Defalt name: .get-port

License

MIT