Skip to content

sindresorhus/p-wait-for

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

p-wait-for Build Status

Wait for a condition to be true

Can be useful for polling.

Install

$ npm install --save p-wait-for

Usage

const pWaitFor = require('p-wait-for');
const pathExists = require('path-exists');

pWaitFor(() => pathExists('unicorn.png')).then(() => {
	console.log('Yay! The file now exists.');
})

API

pWaitFor(condition, [interval])

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 a boolean or a Promise for a boolean.

interval

Type: number
Default: 20

Number of milliseconds to wait before retrying condition.

Related

  • p-whilst - Calls a function repeatedly while a condition returns true and then resolves the promise
  • More…

License

MIT © Sindre Sorhus