Noctiflorous Pansy Mulch

    get-port-electron
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    get-port Build Status

    Get an available TCP port

    This fork is built with electron usage in mind

    Install

    $ npm install get-port-electron
    

    Usage

    const getPort = require('get-port-electron');
     
    (async () => {
        console.log(await getPort());
        //=> 51402
    })();

    Pass in a preferred port:

    (async () => {
        console.log(await getPort({port: 3000}));
        // Will use 3000 if available, otherwise fall back to a random port
    })();

    Pass in an array of preferred ports:

    (async () => {
        console.log(await getPort({port: [3000, 3001, 3002]}));
        // Will use any element in the preferred ports array if available, otherwise fall back to a random port
    })();

    Use the makeRange() helper in case you need a port in a certain range:

    (async () => {
        console.log(await getPort({port: getPort.makeRange(3000, 3100)}));
        // Will use any port from 3000 to 3100, otherwise fall back to a random port
    })();

    API

    getPort(options?)

    Returns a Promise for a port number.

    options

    Type: object

    port

    Type: number | Iterable<number>

    A preferred port or an iterable of preferred ports to use.

    host

    Type: string

    The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.

    getPort.makeRange(from, to)

    Make a range of ports from...to.

    Returns an Iterable for ports in the given range.

    from

    Type: number

    First port of the range. Must be in the range 1024...65535.

    to

    Type: number

    Last port of the range. Must be in the range 1024...65535 and must be greater than from.

    Beware

    There is a very tiny chance of a race condition if another service starts using the same port number as you in between the time you get the port number and you actually start using it.

    Related


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i get-port-electron

    DownloadsWeekly Downloads

    2

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    7.61 kB

    Total Files

    5

    Last publish

    Collaborators

    • adi_random