https://github.com/http-party/node-portfinder

A simple tool to find an open port or domain socket on the current machine
https://github.com/http-party/node-portfinder

Last synced: 6 days ago
JSON representation

A simple tool to find an open port or domain socket on the current machine

• Host: GitHub
• URL: https://github.com/http-party/node-portfinder
• Owner: http-party
• License: other
• Created: 2011-07-08T16:15:01.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T07:44:16.000Z (over 1 year ago)
• Last Synced: 2024-12-31T00:33:55.983Z (15 days ago)
• Language: JavaScript
• Homepage: https://github.com/http-party/node-portfinder
• Size: 183 KB
• Stars: 888
• Watchers: 11
• Forks: 95
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - node-portfinder - A simple tool to find an open port or domain socket on the current machine.  (Repository / Network)
• awesome-github-star - node-portfinder - party | 856 | (JavaScript)
• awesome-nodejs - portfinder - 自动获取可用端口 (Uncategorized / Uncategorized)

README

        
# node-portfinder [![CI](https://github.com/http-party/node-portfinder/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/http-party/node-portfinder/actions/workflows/ci.yml)

## Installation

``` bash

  $ npm install portfinder

```

## Usage

The `portfinder` module has a simple interface:

``` js

  var portfinder = require('portfinder');

  portfinder.getPort(function (err, port) {

    //

    // `port` is guaranteed to be a free port

    // in this scope.

    //

  });

```

Or with promise (if `Promise`s are supported) :

``` js

  const portfinder = require('portfinder');

  portfinder.getPortPromise()

    .then((port) => {

        //

        // `port` is guaranteed to be a free port

        // in this scope.

        //

    })

    .catch((err) => {

        //

        // Could not get a free port, `err` contains the reason.

        //

    });

```

If `portfinder.getPortPromise()` is called on a Node version without Promise (<4), it will throw an Error unless [Bluebird](http://bluebirdjs.com/docs/getting-started.html) or any Promise pollyfill is used.

### Ports search scope

By default `portfinder` will start searching from `8000` and scan until maximum port number (`65535`) is reached.

You can change this globally by setting:

```js

portfinder.setBasePort(3000);    // default: 8000

portfinder.setHighestPort(3333); // default: 65535

```

or by passing optional options object on each invocation:

```js

portfinder.getPort({

    port: 3000,    // minimum port

    stopPort: 3333 // maximum port

}, callback);

```

## Run Tests

``` bash

  $ npm test

```

#### Author: [Charlie Robbins][0]

#### Author/Maintainer: [Erik Trom][1]

#### License: MIT/X11

[0]: http://nodejitsu.com

[1]: https://github.com/eriktrom