package
wait-on is a cross platform command line utility and Node.js API which will wait for files, ports, sockets, and http(s) resources to become available
npm install @metcoder95/wait-onGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Note: This is a fork of the original
wait-onmade by @jeffbski. It respects the given LICENSE from the original fork, and aims to provide a similar functionality with slighlty differences compared to the original project The fork is meant to extend maintenance of the last project while upgrading it by adding support and using up-to-date technologies and practices, like providing TS types, or using Promise as its much extend. This fork is not meant to replace the originalwait-onbut rather coexists and open its arms to any person that wants to continue usingwait-onwhile adding changes on a more regular basis.
wait-on is a cross-platform command line utility which will wait for files, ports, sockets, and http(s) resources to become available (or not available using reverse mode). Functionality is also available via a Node.js API. Cross-platform - runs everywhere Node.js runs (linux, unix, mac OS X, windows)
wait-on will wait for period of time for a file to stop growing before triggering availability which is good for monitoring files that are being built. Likewise wait-on will wait for period of time for other resources to remain available before triggering success.
For http(s) resources wait-on will check that the requests are returning 2XX (success) to HEAD or GET requests (after following any redirects).
wait-on can also be used in reverse mode which waits for resources to NOT be available. This is useful in waiting for services to shutdown before continuing. (Thanks @skarbovskiy for adding this feature)
Node.js >= 16npm install @metcoder95/wait-on # local version and for programatic usage
OR
npm install -g @metcoder95/wait-on # global versionUse from command line or using Node.js programmatic API.
Assuming NEXT_CMD is the command to run when resources are available, then wait-on will wait and then exit with a successful exit code (0) once all resources are available, causing NEXT_CMD to be run.
wait-on can also be used in reverse mode, which waits for resources to NOT be available. This is useful in waiting for services to shutdown before continuing. (Thanks @skarbovskiy for adding)
If wait-on is interrupted before all resources are available, it will exit with a non-zero exit code and thus NEXT_CMD will not be run.
wait-on file1 && NEXT_CMD # wait for file1, then exec NEXT_CMD
wait-on f1 f2 && NEXT_CMD # wait for both f1 and f2, the exec NEXT_CMD
wait-on http://localhost:8000/foo && NEXT_CMD # wait for http 2XX HEAD
wait-on https://myserver/foo && NEXT_CMD # wait for https 2XX HEAD
wait-on http-get://localhost:8000/foo && NEXT_CMD # wait for http 2XX GET
wait-on https-get://myserver/foo && NEXT_CMD # wait for https 2XX GET
wait-on tcp://localhost:4000 && NEXT_CMD # wait for service to listen on a TCP port
wait-on socket:/path/mysock # wait for service to listen on domain socket
wait-on http://unix:/var/SOCKPATH:/a/foo # wait for http HEAD on domain socket
wait-on http-get://unix:/var/SOCKPATH:/a/foo # wait for http GET on domain socketUsage: wait-on {OPTIONS} resource [...resource]
Description:
wait-on is a command line utility which will wait for files, ports,
sockets, and http(s) resources to become available (or not available
using reverse flag). Exits with success code (0) when all resources
are ready. Non-zero exit code if interrupted or timed out.
Options may also be specified in a config file (js or json). For
example --config configFile.js would result in configFile.js being
required and the resulting object will be merged with any
command line options before wait-on is called. See exampleConfig.js
In shell combine with && to conditionally run another command
once resources are available. ex: wait-on f1 && NEXT_CMD
resources types are defined by their prefix, if no prefix is
present, the resource is assumed to be of type 'file'. Resources
can also be provided in the config file.
resource prefixes are:
file: - regular file (also default type). ex: file:/path/to/file
http: - HTTP HEAD returns 2XX response. ex: http://m.com:90/foo
https: - HTTPS HEAD returns 2XX response. ex: https://my/bar
http-get: - HTTP GET returns 2XX response. ex: http://m.com:90/foo
https-get: - HTTPS GET returns 2XX response. ex: https://my/bar
tcp: - TCP port is listening. ex: tcp://localhost:4000 or tcp://foo:7000
const { WaitOn } = require('@metcoder95/wait-on');
WaitOn({
resources: [
'http://localhost:3000',
'tcp://localhost:3001',
'some-file.txt',
'/Users/metcoder95/path-to-file',
'../file.txt',
],
timeout: 10000,
events: {
onResourceResponse: console.log,
},
}).then((res) => console.log('done:', res), console.error);import WaitOn from '@metcoder95/wait-on';
WaitOn({
resources: [
'http://localhost:3000',
'tcp://localhost:3001',
'some-file.txt',
'/Users/metcoder95/path-to-file',
'../file.txt',
],
timeout: 10000,
events: {
onResourceResponse: console.log,
},
}, (err: Error, result: boolean) => {
if (err != null) console.error(err)
else console.log(result)
}).wait-on function can be called by either passing a callback or just calling the function. If not callback provided, a Promise<boolean> will be returned, otherwise the callback provided will be called once the set of checks are done.
import { ProxyAgent } from 'undici';
type WaitOnCallback = (err?: Error, result: boolean) => unknown;
declare function WaitOn(
options: WaitOnOptions,
cb: WaitOnCallback
): Promise<boolean>;
declare function WaitOn(options: WaitOnOptions): Promise<boolean>;
type WaitOnProxyConfig = ProxyAgent.Options;
/**
*
I frequently need to wait on build tasks to complete or services to be available before starting next command, so this project makes that easier and is portable to everywhere Node.js runs.
If you have input or ideas or would like to get involved, you may:
Estimated unpacked size across 27 packages.
3.9 MB
Includes dependencies.
^8.0.1
10.0.0
^6.14.1
8.12.4
^1.4.0
1.4.0
^1.2.7
1.2.8
^4.0.0
4.0.0