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

find-free-ports

v3.1.1

Published

Find multiple free ports on localhost

Downloads

44,759

Readme

This is a very small package that allows developers to find free ports on the local system. Unlike most other "find-free-port" utilities, this library allows scanning for multiple free ports at once, making sure that there are no doubles in the result.

✔️ TypeScript support

✔️ No dependencies

✔️ Should work on all major NodeJS versions

✔️ Now automatically tested for mistakes

This library has been benchmarked and parallelises the port checks using a customisable number of workers for optimal performance. The alogithm does not create a new anonymous socket for each port, but instead iterates in parallell over the system's port numbers. This is both faster and less resource-intensive.

🔍 Found an issue? Please let me know in the issue tracker and we'll get it fixed ASAP.

npm i find-free-ports

Usage

Import the library:

import findFreePorts from "find-free-ports"

or

const findFreePorts = require('find-free-ports');

Next, call the main function with the amount of free ports you need:

async function startMultipleServers() {
  const [a, b, c, d] = await findFreePorts(4);
  // now do something interesting with the new ports ...
}

API

findFreePorts(count?, opts?)

import { findFreePorts } from "find-free-ports"

Search for the specified amount of free ports on the local machine. If count is left unspecified, it defaults to 1. opts may be a dictionary containing one of the following keys:

  • isFree: custom function that is used to check whether the given port is free
  • startPort: start scanning for free ports starting from this port number. Defaults to 1025.
  • endPort: prevent the scanner from exceeding this port number. Defaults to 65535.
  • jobCount: how much workers that may at most be looking for free ports

isFreePort(port)

import { isFreePort } from "find-free-ports"

Check whether the given port is free by trying to set up a socket.

This function returns a promise containing either true or false depending on whether the port was available.

FindFreePortsOptions

import { FindFreePortsOptions } from "find-free-ports"

A TypeScript interface that lists all valid options that may be passed as the opts parameter to findFreePorts().

Similar Packages

License

The MIT License