delay's Introduction

delay

Delay a promise a specified amount of time

Install

$ npm install --save delay

Usage

const delay = require('delay');

delay(200)
	.then(() => {
		// Executed after 200 milliseconds
	});

delay(100, 'a result')
	.then(result => {
		// Executed after 100 milliseconds
		// result === 'a result';
	});

Advanced usage

const delay = require('delay');

// With Node.js >=7.6 and async functions
(async () => {
	bar();

	await delay(100);

	// Executed 100 milliseconds later
	baz();
})();

// There's also `delay.reject()` which optionally accepts a value and rejects it `ms` later
delay.reject(100, 'foo'))
	.then(x => blah()) // Never executed
	.catch(err => {
		// Executed 100 milliseconds later
		// err === 'foo'
	});

// You can cancel the promise by calling `.cancel()`
(async () => {
	try {
		const delayedPromise = delay(1000);
		setTimeout(() => {
			delayedPromise.cancel();
		}, 500);
		await delayedPromise;
	} catch (err) {
		// `err` is an instance of `delay.CancelError`
	}
})();

API

delay(ms, [value])

Create a promise which resolves after the specified ms. Optionally pass a value to resolve.

delay.reject(ms, [value])

Create a promise which rejects after the specified ms. Optionally pass a value to reject.

ms

Type: number

Milliseconds to delay the promise.

value

Type: any

Value to resolve or reject in the returned promise.

delay.CancelError

Exposed for instance checking.

delay#cancel()

Cancel the delay. Results in the promise being rejected with a delay.CancelError error.

delay-cli - CLI for this module
p-min-delay - Delay a promise a minimum amount of time
p-immediate - Returns a promise resolved in the next event loop - think setImmediate()
p-timeout - Timeout a promise after a specified amount of time
More…