40 lines
939 B
Markdown
40 lines
939 B
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
|
||
|
|
|
||
|
|
```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)
|