port-get

1.0.4 • Public • Published

port-get

Get an available TCP port (a minimal CJS module)

Install

npm install port-get

Usage

const portGet = require('@holepunchto/port-get')

async function run () {
  console.log('here is a port', await portGet())
}

run.catch(console.error)

Provide a port list. If all ports are unavailable will pick another port.

const portGet = require('@holepunchto/port-get')

async function run () {
  console.log('here is a port', await portGet([7777, 7779, 7779]))
}

run.catch(console.error)

Defaults to providing port on host 127.0.0.1, set host

const portGet = require('@holepunchto/port-get')

async function run () {
  console.log('here is any public port', await portGet('0.0.0.0'))
  console.log('here is a target public port', await portGet([7777, 7779, 7779], '0.0.0.0'))

}

run.catch(console.error)

Prior Art

License

BSD-3-Clause

Package Sidebar

Install

npm i port-get

Weekly Downloads

199

Version

1.0.4

License

Apache-2.0

Unpacked Size

17.3 kB

Total Files

6

Last publish

Collaborators

  • mafintosh
  • davidmarkclements