Refactor TypeScript definition to CommonJS compatible export (#4)
This commit is contained in:
parent
d43a753a44
commit
23a0139209
|
@ -1,4 +1,5 @@
|
|||
export interface DeferredPromise<ValueType> {
|
||||
declare namespace pDefer {
|
||||
interface DeferredPromise<ValueType> {
|
||||
/**
|
||||
Resolves the promise with a value or the result of another promise.
|
||||
|
||||
|
@ -17,9 +18,37 @@ export interface DeferredPromise<ValueType> {
|
|||
The deferred promise.
|
||||
*/
|
||||
promise: Promise<ValueType>;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
Create a deferred promise.
|
||||
*/
|
||||
export default function pDefer<ValueType = unknown>(): DeferredPromise<ValueType>;
|
||||
declare const pDefer: {
|
||||
/**
|
||||
Create a deferred promise.
|
||||
|
||||
@example
|
||||
```
|
||||
import pDefer = require('p-defer');
|
||||
|
||||
function delay(ms) {
|
||||
const deferred = pDefer();
|
||||
setTimeout(deferred.resolve, ms, '🦄');
|
||||
return deferred.promise;
|
||||
}
|
||||
|
||||
(async () => {
|
||||
console.log(await delay(100));
|
||||
//=> '🦄'
|
||||
})();
|
||||
```
|
||||
*/
|
||||
<ValueType = unknown>(): 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;
|
||||
|
|
1
index.js
1
index.js
|
@ -12,4 +12,5 @@ const pDefer = () => {
|
|||
};
|
||||
|
||||
module.exports = pDefer;
|
||||
// TODO: Remove this for the next major release
|
||||
module.exports.default = pDefer;
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
import {expectType} from 'tsd-check';
|
||||
import pDefer, {DeferredPromise} from '.';
|
||||
import {expectType} from 'tsd';
|
||||
import pDefer = require('.');
|
||||
import {DeferredPromise} from '.';
|
||||
|
||||
expectType<DeferredPromise<unknown>>(pDefer());
|
||||
expectType<DeferredPromise<string>>(pDefer<string>());
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
"node": ">=6"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd-check"
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
|
@ -33,8 +33,8 @@
|
|||
"bluebird"
|
||||
],
|
||||
"devDependencies": {
|
||||
"ava": "^1.3.1",
|
||||
"tsd-check": "^0.5.0",
|
||||
"ava": "^1.4.1",
|
||||
"tsd": "^0.7.2",
|
||||
"xo": "^0.24.0"
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue