@functionalfoundry/await-url
v0.3.3
Published
Wait for a given URL to continue.
Downloads
22
Readme
await-url
Wait for a given URL to continue.
Why?
- Alias a deployment when it is ready.
- Run a health check on your service.
- Know when it is safe to share.
Install
npm install await-url --global
Usage
$ await-url --help
Usage
$ await-url <url>
Option
--tries Maximum number of polling attempts
--interval Milliseconds to wait between tries
Example
$ await-url example.com/status
$ await-url example.com --tries=3 --interval=1000
Polling a URL until it returns 200 OK is especially useful to avoid sending traffic to it before it is ready. See a real example of deploying a server in CI.
Please consider whether a more efficient, event-based model is available to you before using this.
Option
tries
Type: number
Default: 150
Maximum number of polling attempts to make before timing out.
interval
Type: number
Default: 1200
Number of milliseconds to wait between polling attempts.
Contributing
See our contributing guidelines for more details.
- Fork it.
- Make a feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request.
License
Go make something, dang it.