npmpackage.info

Gathering detailed insights and metrics for wait-port

Other packages similar to wait-port

wait-for-localhost

4.1.0

Wait for localhost to be ready

wait-for-port

0.0.2

wait for host/port to become available

wait-port-ng

0.3.1

Utility to wait for a TCP port to open.

wait-till-port-open

1.0.0

A promise that waits till a port is open

Gathering detailed insights and metrics for wait-port

wait-port - 1.1.0 | npmpackage.info

wait-port

Simple binary to wait for a port to open. Useful for docker-compose and general server side activities.

1.1.0

342

MIT

JavaScript

41.25 kB

3.2

Installations

npm install wait-port

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

18.17.1

NPM Version

9.6.7 Pull Requests

Open

1

Total

78

Closed

10

Merged

67

Issues

Open

9

Total

27

Closed

18

Releases

v1.1.0

Updated on Sep 20, 2023

v1.0.4

Updated on Oct 18, 2022

v1.0.3

Updated on Oct 12, 2022

v1.0.2

Updated on Oct 12, 2022

v1.0.1

Updated on Sep 20, 2022

v1.0.0

Updated on Sep 08, 2022

View All 13 releases

Languages

JavaScript

Makefile

JavaScript (98.79%)

Makefile (1.21%)

Developer

dwmkerr

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

342 Stars

162 Commits

18 Forks

3 Watchers

16 Branches

12 Contributors

Updated on Jun 30, 2025

Maintainers

View All 12 Contributors

Package Meta Information

Latest Version

1.1.0

Package Id

wait-port@1.1.0

Unpacked Size

41.25 kB

Size

11.61 kB

File Count

NPM Version

9.6.7

Node Version

18.17.1

Published on

Sep 20, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chalk commander debug

Dev Dependencies

codecov eslint eslint-plugin-import eslint-plugin-node mocha mocha-junit-reporter nyc sinon

wait-port

Simple binary to wait for a port to open. Useful when writing scripts which need to wait for a server to be available.

Creating docker-compose commands which wait for servers to start
Wait for an HTTP endpoint to successfully respond
Wait for DNS records to be resolvable
Wait for application servers to start

Installation
Usage
- Parameters
- Error Codes
API
Developer Guide
- Debugging
- Testing
- Testing the CLI
- Manpage
- Releasing
- Timeouts

Installation

Install globally with npm:

$ npm install -g wait-port

If installing locally, run the binary from the local node modules binary folder:

$ npm install wait-port
wait-port@0.1.3

$ ./node_modules/.bin/wait-port 8080
Waiting for localhost:8080.....
Connected!

Ideally, Node LTS should be used however this package is tested successfully with Node.js 10 and upwards.

Please avoid using version 0.2.13 - this incorrectly included a breaking change. Use 0.2.14 if you need compatibility with Node 8, or 0.3.0 or upwards otherwise.

Usage

To wait indefinitely for a port to open, just use:

1$ wait-port localhost:3000

To wait for a port to open, but limit to a certain timeout, use:

1$ wait-port -t 10000 localhost:3000

To wait for an HTTP endpoint to respond with a 200 class status code, include the http:// protocol:

1$ wait-port http://:3000/healthcheck

Parameters

The following parameters are accepted:

Parameter	Usage
`<target>`	Required. The target to test for. Can be just a port, a colon and port (as one would use with httpie or host and port. Examples: `8080`, `:3000`, `127.0.0.1:443`.
`--output, -o`	Optional. Output style to use. Can be `dots` (default) or `silent` (no output).
`--timeout, -t`	Optional. Timeout (in milliseconds).
`--wait-for-dns`	Optional. Do not error if the response is `ENOTFOUND`, just keep on waiting (useful if you are waiting for a DNS record to also be created).

Error Codes

The following error codes are returned:

Code	Meaning
`0`	The specified port on the host is accepting connections.
`1`	A timeout occurred waiting for the port to open.
`2`	An unknown error occurred waiting for the port to open. The program cannot establish whether the port is open or not.
`3`	The address cannot be found (e.g. no DNS entry, or unresolvable).
`4`	The target (host and port) is invalid.

API

You can use wait-port programmatically:

1const waitPort = require('wait-port');
2
3const params = {
4  host: 'google.com',
5  port: 443,
6};
7
8waitPort(params)
9  .then(({ open, ipVersion }) => {
10    if (open) console.log(`The port is now open on IPv${ipVersion}!`);
11    else console.log('The port did not open before the timeout...');
12  })
13  .catch((err) => {
14    console.err(`An unknown error occured while waiting for the port: ${err}`);
15  });

The CLI is a very shallow wrapper around this function. The params object takes the following parameters:

CLI Parameter	API Parameter	Notes
`<target>`	`host`	Optional. Defaults to `localhost`.
`<target>`	`port`	Required. Port to wait for.
`--output`	`output`	Optional. Defaults to `dots`. Output style to use. `silent` also accepted.
`--timeout, -t`	`timeout`	Optional. Defaults to `0`. Timeout (in milliseconds). If `0`, then the operation will never timeout.
`--wait-for-dns`	`waitForDns`	Optional. Defaults to `false`.

Developer Guide

This module uses:

Name	Usage
`chalk`	Terminal output styling.
`commander.js`	Utility for building commandline apps.
`debug`	Utility for debug output.
`mocha` / `nyc`	Test runner / coverage.

Debugging

This module use debug for debug output. Set DEBUG=wait-port to see detailed diagnostic information:

1DEBUG=wait-port wait-for -t 10000 localhost:6234

This will also work for any code which uses the API.

Testing

Run unit tests with npm test. Coverage is reported to artifacts/coverage.

Debug unit tests with npm run debug. Add a debugger statement to the line you are interested in, and consider limiting scope with .only.

Run tests continuously, watching source with npm run test:watch.

Testing the CLI

Don't install the package to test the CLI. Instead, in the project folder run npm link. Now go to whatever folder you want to use the module in and run npm link wait-port. It will symlink the package and binary. See npm link for more details.

Manpage

Installing the CLI will install the manpage. The manpage is at ./man/wait-port.1. After updating the page, test it with man ./man/wait-port.1 before publishing, as the format can be tricky to work with.

Releasing

Kick out a new release with:

1npm run release
2git push --follow-tags
3npm publish

standard-version is used to manage version numbers and the CHANGELOG.md file.

CI/CD

CI/CD runs as a set of GitHub actions. There are two pipelines:

Validate Pull Request - confirms that a PR meets the required standardsd
Release Please - prepares changelogs and release PRs, and publishes to NPM

Timeouts

The timeout option for waitPort is used terminate attempts to open the socket after a certain amount of time has passed. Please note that operations can take significantly longer than the timeout. For example:

1const promise = waitPort({ port: 9000, interval: 10000 }, 2000);

In this case, the socket will only attempt to connect every ten seconds. So on the first iteration, the timeout is not reached, then another iteration will be scheduled for after ten seconds, meaning the timeout will happen eight seconds later than one might expect.

The waitPort promise may take up to interval milliseconds greater than timeout to resolve.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More