Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/p-defer
Create a deferred promise
https://github.com/sindresorhus/p-defer
Last synced: about 2 months 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 (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T05:15:25.000Z (3 months ago)
- Last Synced: 2024-04-23T11:12:40.687Z (2 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 66
- Watchers: 8
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Lists
- awesome-promises - p-defer - Create a deferred promise (Convenience Utilities / sindresorhus's many Promise utilities ([see notes](https://github.com/sindresorhus/promise-fun)))
- promise-fun - p-defer
- awesome-stars - p-defer - Create a deferred promise (JavaScript)
- awesome-stars - p-defer - Create a deferred promise (JavaScript)
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
```
$ 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)---
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.