Need help with wait-port?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

dwmkerr
137 Stars 12 Forks MIT License 120 Commits 15 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

# 7,271
C#
hugo
Shell
space-i...
54 commits
# 176
nextjs
postman...
graphql...
angular...
17 commits
# 30,958
TypeScr...
pkg
nsis
Electro...
1 commit
# 352,885
Android
React N...
Objecti...
Shell
1 commit
# 31,225
React N...
Objecti...
Materia...
React
1 commit
# 97,657
React
TypeScr...
tailwin...
reactjs
1 commit

wait-port

CircleCI codecov npm version Greenkeeper badge GuardRails badge

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

wait-port screenshot

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
[email protected]

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

Requires Node 8 or later.

Usage

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

$ wait-port localhost:3000

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

$ wait-port -t 10000 localhost:3000

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

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

Parameters

The following parameters are accepted:

| Parameter | Usage | |-----------|-------| |

 | 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:
const waitPort = require('wait-port');

const params = { host: 'google.com', port: 443, };

waitPort(params) .then((open) => { if (open) console.log('The port is now open!'); else console.log('The port did not open before the timeout...'); }) .catch((err) => { console.err(An unknown error occured while waiting for the port: ${err}); });

The CLI is a very shallow wrapper around this function. The

params
object takes the following parameters:

| CLI Parameter | API Parameter | Notes | |---------------|---------------|-------| |

      | 
host
| Optional. Defaults to
localhost
. | |
      | 
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:
DEBUG=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:

npm run release
git push --follow-tags
npm publish

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

CI/CD

CI runs on CircleCI 2. You can validate the Circle configuration with the following command:

make circleci

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:
const 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.