+17
-26
@@ -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; |
+0
-2
@@ -15,3 +15,1 @@ 'use strict'; | ||
| module.exports = pDefer; | ||
| // TODO: Remove this for the next major release | ||
| module.exports.default = pDefer; |
+5
-6
| { | ||
| "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" | ||
| } | ||
| } |
+1
-6
@@ -39,3 +39,3 @@ # p-defer [](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
-9.71%46
-17.86%46
-9.8%