Wait for localhost to be ready
npm install 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.
Supports both HTTP/1 and HTTP/2 servers with automatic fallback.
``sh`
npm install wait-for-localhost
`js
import waitForLocalhost from 'wait-for-localhost';
await waitForLocalhost({port: 8080});
console.log('Server is ready');
`
Returns a Promise
The object contains an ipVersion property with a value of either 6 or 4 depending on the IP version that was used.
#### options
Type: object
##### port
Type: number\80
Default:
##### path
Type: string\'/'
Default:
Use a custom path.
For example, /health for a health-check endpoint.
##### useGet
Type: boolean\false
Default:
Use the GET HTTP-method instead of HEAD to check if the server is running.
##### statusCodes
Type: number[]\[200]
Default:
HTTP status codes to consider as successful responses.
##### signal
Type: AbortSignal
An AbortSignal to abort the operation.
`js
import waitForLocalhost from 'wait-for-localhost';
// Timeout after 5 seconds
await waitForLocalhost({
port: 8080,
signal: AbortSignal.timeout(5000)
});
``
- wait-for-localhost-cli - CLI for this module
- delay - Delay execution for a given amount of seconds