wait-for-localhost ![Build Status](https://travis-ci.org/sindresorhus/wait-for-localhost.svg?branch=master)
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 --global wait-for-localhost
Usage
const waitForLocalhost = require('wait-for-localhost');
(async () => {
await waitForLocalhost({port: 8080});
console.log('Server is ready');
})();
API
waitForLocalHost([options])
Returns a Promise
that settles when localhost is ready.
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
License
MIT © Sindre Sorhus