https://github.com/sindresorhus/p-defer

Create a deferred promise
https://github.com/sindresorhus/p-defer

Last synced: 5 days ago
JSON representation

Create a deferred promise

• Host: GitHub
• URL: https://github.com/sindresorhus/p-defer
• Owner: sindresorhus
• License: mit
• Created: 2016-10-21T05:07:59.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T05:15:25.000Z (10 months ago)
• Last Synced: 2025-01-03T13:34:14.952Z (12 days ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 77
• Watchers: 8
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• promise-fun - p-defer

README

        
# p-defer

> Create a deferred promise

[Don't use this unless you know what you're doing.](https://github.com/petkaantonov/bluebird/wiki/Promise-anti-patterns#the-deferred-anti-pattern) Prefer the `Promise` constructor.

## Install

```sh

npm install p-defer

```

## Usage

```js

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`](https://github.com/sindresorhus/delay) if you need to delay a promise.*

## API

### pDefer()

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

## Related

- [p-lazy](https://github.com/sindresorhus/p-lazy) - Create a lazy promise that defers execution until `.then()` or `.catch()` is called

- [More…](https://github.com/sindresorhus/promise-fun)