4.0.1 • Published 2 years ago
wait-for-localhost v4.0.1
wait-for-localhost
Wait for localhost to be ready
Useful if you need a local server to be ready to accept requests before doing other things.
Install
npm install wait-for-localhost
Usage
import waitForLocalhost from 'wait-for-localhost';
await waitForLocalhost({port: 8080});
console.log('Server is ready');
API
waitForLocalHost(options?)
Returns a Promise<object>
that settles when localhost is ready.
The object contains a ipVersion
property with a value of either 6
or 4
depending on the IP version that was used.
options
Type: object
port
Type: number
\
Default: 80
path
Type: string
\
Default: '/'
Use a custom path.
For example, /health
for a health-check endpoint.
useGet
Type: boolean
\
Default: false
Use the GET
HTTP-method instead of HEAD
to check if the server is running.
Related
- wait-for-localhost-cli - CLI for this module
- delay - Delay execution for a given amount of seconds