npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

port-walker

v2.0.2

Published

Check ports status to find an available one

Downloads

5

Readme

port-walker

Walks ports to find an available one to use.

This package purpose IS NOT to be use in production. This package aims at being used in a DEVELOPMENT environment.

Install

$ npm install port-walker --save

Example

const walkPort = require('port-walker');

walkPort({ port: 3000, host: '127.0.0.1' })
    .then((port) => {
        server = app.listen(port, () => {
            console.log(`Server started at http://localhost:${port}/`);
        });
    })
    .catch((rejection) => {
        console.error(rejection.error);
        process.exit(1);
    });

See the demo folder for more advanced options.

Api

/**
    'parameters' could be a number (port number), or an object with the properties
    described in node documentation at https://nodejs.org/docs/latest-v4.x/api/net.html#net_server_listen_options_callback
*/

/**
    'options' is an object with the following properties:
    {{
        onBusyPort: [function]  optional, by default 'noop', callback used before walking up to the next port
        onRetry:    [function]  optional, by default 'noop', callback used to retry when port is already in use
        retry:      [number]    optional, by default 0,      number of retry for a given port
        recursive:  [boolean]   optional, by default true,   if false prevents walking up ports
        timeout:    [number]    optional, by default 0,      time to wait before retries and walking up ports
    }}
*/

const walkPort = require('port-walker');
const promise = walkPort(parameters, options);

/**
    the return value of 'walk-port' is an ES6 Promise.
*/
promise
    .then((result) => { ... })
    .catch((rejection) => { ... });

/**
    When resolving, 'result' is the available port number.
    When rejecting, 'rejection' is an object containing the error.
*/

That's all folks!