Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

p-defer

sindresorhus28mMIT4.0.1TypeScript support: included

Create a deferred promise

promise, defer, deferred, resolve, reject, lazy, later, async, await, promises

readme

p-defer

Create a deferred promise

Don't use this unless you know what you're doing. Prefer the Promise constructor.

Install

npm install p-defer

Usage

import pDefer from 'p-defer';

function delay(milliseconds) {
    const deferred = pDefer();
    setTimeout(deferred.resolve, milliseconds, '🦄');
    return deferred.promise;
}

console.log(await delay(100));
//=> '🦄'

The above is just an example. Use delay if you need to delay a promise.

API

pDefer()

Returns an object with a promise property and functions to resolve() and reject().

  • p-lazy - Create a lazy promise that defers execution until .then() or .catch() is called
  • More…