Package Exports
- p-wait-for
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (p-wait-for) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
p-wait-for
Wait for a condition to be true
Can be useful for polling.
Install
$ npm install p-wait-forUsage
const pWaitFor = require('p-wait-for');
const pathExists = require('path-exists');
(async () => {
await pWaitFor(() => pathExists('unicorn.png'));
console.log('Yay! The file now exists.');
})();API
pWaitFor(condition, options?)
Returns a Promise that resolves when condition returns true. Rejects if condition throws or returns a Promise that rejects.
condition
Type: Function
Expected to return Promise<boolean> | boolean.
options
Type: object
interval
Type: number
Default: 20
Number of milliseconds to wait before retrying condition.
timeout
Type: number
Default: Infinity
Number of milliseconds to wait before automatically rejecting.
leadingCheck
Type: boolean
Default: true
Whether to run the check immediately rather than starting by waiting interval milliseconds.
Useful for when the check, if run immediately, would likely return false. In this scenario, set leadingCheck to false.