2016-10-21 05:07:52 +00:00
# p-defer [![Build Status](https://travis-ci.org/sindresorhus/p-defer.svg?branch=master)](https://travis-ci.org/sindresorhus/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 --save p-defer
```
## Usage
```js
const pDefer = require('p-defer');
function delay(ms) {
const deferred = pDefer();
setTimeout(deferred.resolve, ms, '🦄');
return deferred.promise;
}
2019-03-17 12:21:07 +00:00
(async () => {
console.log(await delay(100));
//=> '🦄'
})();
2016-10-21 05:07:52 +00:00
```
*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
2016-11-07 09:11:47 +00:00
- [p-lazy ](https://github.com/sindresorhus/p-lazy ) - Create a lazy promise that defers execution until `.then()` or `.catch()` is called
2016-10-21 05:07:52 +00:00
- [More… ](https://github.com/sindresorhus/promise-fun )
## License
MIT © [Sindre Sorhus ](https://sindresorhus.com )