JSPM

first-open-port

0.1.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 78
  • Score
    100M100P100Q85089F
  • License MIT

find the first open port on localhost within a range of specified ports

Package Exports

  • first-open-port

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (first-open-port) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

first-open-port

Build Status Coverage Status


About | Installation | Usage | License

About

A tiny Node.js module to get the first available port on localhost in a given range. Handy for avoiding hard-coded port conflicts (EADDRINUSE) if you frequently spin up more than one local server during development. Returns a Promise.

Installation

Install and require as a standard Node module.

Install

  $ npm install --save first-open-port

Require

  var firstOpenPort = require('first-open-port')

Usage

firstOpenPort(start, max)

  • start : Number : begin search at this port
  • (max) : Number : optional last port to search before rejecting

Returns a bluebird Promise that resolves with the first open port or rejects with an error if no open ports are found in the given range.

var firstOpenPort = require('first-open-port')

firstOpenPort(3000, 3100)
  .then(port => {
    // start a server on that port
  })
  .catch(err => {
    // do something when no ports are available
  })

License

MIT