52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
# 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)
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<b>
|
|
<a href="https://tidelift.com/subscription/pkg/npm-p-defer?utm_source=npm-p-defer&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
|
</b>
|
|
<br>
|
|
<sub>
|
|
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
|
</sub>
|
|
</div>
|