p-defer
Advanced tools
Comparing version 2.1.0 to 3.0.0
@@ -24,32 +24,23 @@ declare namespace pDefer { | ||
declare const pDefer: { | ||
/** | ||
Create a deferred promise. | ||
/** | ||
Create a deferred promise. | ||
@example | ||
``` | ||
import pDefer = require('p-defer'); | ||
@example | ||
``` | ||
import pDefer = require('p-defer'); | ||
function delay(ms) { | ||
const deferred = pDefer(); | ||
setTimeout(deferred.resolve, ms, '🦄'); | ||
return deferred.promise; | ||
} | ||
function delay(ms) { | ||
const deferred = pDefer(); | ||
setTimeout(deferred.resolve, ms, '🦄'); | ||
return deferred.promise; | ||
} | ||
(async () => { | ||
console.log(await delay(100)); | ||
//=> '🦄' | ||
})(); | ||
``` | ||
*/ | ||
<ValueType = unknown>(): pDefer.DeferredPromise<ValueType>; | ||
(async () => { | ||
console.log(await delay(100)); | ||
//=> '🦄' | ||
})(); | ||
``` | ||
*/ | ||
declare function pDefer<ValueType>(): pDefer.DeferredPromise<ValueType>; | ||
// TODO: Remove this for the next major release, refactor the whole definition to: | ||
// declare function pDefer<ValueType = unknown>(): pDefer.DeferredPromise< | ||
// ValueType | ||
// >; | ||
// export = pDefer; | ||
default: typeof pDefer; | ||
}; | ||
export = pDefer; |
@@ -15,3 +15,1 @@ 'use strict'; | ||
module.exports = pDefer; | ||
// TODO: Remove this for the next major release | ||
module.exports.default = pDefer; |
{ | ||
"name": "p-defer", | ||
"version": "2.1.0", | ||
"version": "3.0.0", | ||
"description": "Create a deferred promise", | ||
@@ -13,3 +13,3 @@ "license": "MIT", | ||
"engines": { | ||
"node": ">=6" | ||
"node": ">=8" | ||
}, | ||
@@ -33,10 +33,9 @@ "scripts": { | ||
"await", | ||
"promises", | ||
"bluebird" | ||
"promises" | ||
], | ||
"devDependencies": { | ||
"ava": "^1.4.1", | ||
"tsd": "^0.7.2", | ||
"ava": "^2.0.0", | ||
"tsd": "^0.7.3", | ||
"xo": "^0.24.0" | ||
} | ||
} |
@@ -39,3 +39,3 @@ # p-defer [![Build Status](https://travis-ci.org/sindresorhus/p-defer.svg?branch=master)](https://travis-ci.org/sindresorhus/p-defer) | ||
Returns an `Object` with a `promise` property and functions to `resolve()` and `reject()`. | ||
Returns an `object` with a `promise` property and functions to `resolve()` and `reject()`. | ||
@@ -47,6 +47,1 @@ | ||
- [More…](https://github.com/sindresorhus/promise-fun) | ||
## License | ||
MIT © [Sindre Sorhus](https://sindresorhus.com) |
3886
46
46