diff --git a/.editorconfig b/.editorconfig index 98a761d..1c6314a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,6 +7,6 @@ charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true -[{package.json,*.yml}] +[*.yml] indent_style = space indent_size = 2 diff --git a/.gitattributes b/.gitattributes index 391f0a4..6313b56 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1 @@ -* text=auto -*.js text eol=lf +* text=auto eol=lf diff --git a/.gitignore b/.gitignore index 3c3629e..239ecff 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ node_modules +yarn.lock diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..43c97e7 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.travis.yml b/.travis.yml index 97519af..2ae9d62 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ language: node_js node_js: + - '10' + - '8' - '6' - - '4' diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..a23b693 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,27 @@ +export interface DeferredPromise { + /** + Resolves the promise with a value or the result of another promise. + + @param value - The value to resolve the promise with. + */ + resolve(value: ValueType | PromiseLike): void; + + /** + Reject the promise with a provided reason or error. + + @param reason - The reason or error to reject the promise with. + */ + reject(reason: unknown): void; + + /** + The deferred promise. + */ + promise: Promise; +} + +/** +Create a deferred promise. +*/ +export default function pDefer(): DeferredPromise< + ValueType +>; diff --git a/index.js b/index.js index eaef75e..c598621 100644 --- a/index.js +++ b/index.js @@ -1,5 +1,6 @@ 'use strict'; -module.exports = () => { + +const pDefer = () => { const ret = {}; ret.promise = new Promise((resolve, reject) => { @@ -9,3 +10,6 @@ module.exports = () => { return ret; }; + +module.exports = pDefer; +module.exports.default = pDefer; diff --git a/index.test-d.ts b/index.test-d.ts new file mode 100644 index 0000000..a623865 --- /dev/null +++ b/index.test-d.ts @@ -0,0 +1,9 @@ +import {expectType} from 'tsd-check'; +import pDefer, {DeferredPromise} from '.'; + +expectType>(pDefer()); +expectType>(pDefer()); + +pDefer().resolve('foo'); +pDefer().reject(new Error('foo')); +expectType>(pDefer().promise); diff --git a/license b/license index 654d0bf..e7af2f7 100644 --- a/license +++ b/license @@ -1,21 +1,9 @@ -The MIT License (MIT) +MIT License Copyright (c) Sindre Sorhus (sindresorhus.com) -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/package.json b/package.json index f3ba494..1577101 100644 --- a/package.json +++ b/package.json @@ -1,41 +1,40 @@ { - "name": "p-defer", - "version": "1.0.0", - "description": "Create a deferred promise", - "license": "MIT", - "repository": "sindresorhus/p-defer", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "engines": { - "node": ">=4" - }, - "scripts": { - "test": "xo && ava" - }, - "files": [ - "index.js" - ], - "keywords": [ - "promise", - "defer", - "deferred", - "resolve", - "reject", - "lazy", - "later", - "async", - "await", - "promises", - "bluebird" - ], - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "xo": { - "esnext": true - } + "name": "p-defer", + "version": "1.0.0", + "description": "Create a deferred promise", + "license": "MIT", + "repository": "sindresorhus/p-defer", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava && tsd-check" + }, + "files": [ + "index.js", + "index.d.ts" + ], + "keywords": [ + "promise", + "defer", + "deferred", + "resolve", + "reject", + "lazy", + "later", + "async", + "await", + "promises", + "bluebird" + ], + "devDependencies": { + "ava": "^1.3.1", + "tsd-check": "^0.5.0", + "xo": "^0.24.0" + } } diff --git a/readme.md b/readme.md index d9a7a1f..5648502 100644 --- a/readme.md +++ b/readme.md @@ -23,8 +23,10 @@ function delay(ms) { return deferred.promise; } -delay(100).then(console.log); -//=> '🦄' +(async () => { + 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.* diff --git a/test.js b/test.js index c7f0b40..6e65a6c 100644 --- a/test.js +++ b/test.js @@ -1,14 +1,14 @@ import test from 'ava'; -import m from './'; +import pDefer from '.'; const fixture = Symbol('fixture'); function delay(ms) { - const deferred = m(); + const deferred = pDefer(); setTimeout(deferred.resolve, ms, fixture); return deferred.promise; } -test(async t => { +test('main', async t => { t.is(await delay(50), fixture); });