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

listen-on-free-port

v1.0.3

Published

Find a free port and listen on it

Downloads

33

Readme

listen-on-free-port

Circle CI npm version

This module exports a function for finding a free port and listening to on it.

This module differs from other similar modules like find-port because this module leaves you with a server already listening on the first free port instead of returning a number naming a free port for you to listen to. This avoids race conditions where another program could start listening on a port between the time find-port tells you it's free and you start listening to it yourself.

listenOnFreePort(portOrRange, extraListenArgs, createFn)

portOrRange must be a number naming the first port to try to listen on, or an array of two numbers specifying a range by the first and last allowable port numbers.

extraListenArgs argument is an optional array of extra arguments to pass to the .listen call after the port number. (This can be used to pass the hostname and backlog arguments.) null will be treated as an empty array.

createFn must be a function which returns a server object. This function may be called multiple times until a free port is found. The returned server object must have a listen method and extend EventEmitter. The server object could be a native node net.Server or http.Server object for example.

The function returns a Promise for the listening server object. This will be the object returned from the last call to createFn.

Example

var net = require('net');
var listenOnFreePort = require('listen-on-free-port');

listenOnFreePort(1234, ['localhost'], () =>
  net.createServer(c => {
    console.log('client connected from', c.address().address);
    c.on('end', () => {
      console.log('client disconnected');
    });
    c.write('hello\r\n');
    c.pipe(c);
  })
).then(server => {
  console.log("Started listening on port", server.address().port);
}, err => {
  console.error("Failed to start server", err);
});

Types

Full Flow Type declarations for this module are included!