Require Node.js 6, add TypeScript definition (#2)

.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

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,4 +1,5 @@
 language: node_js
 node_js:
+  - '10'
+  - '8'
   - '6'
-  - '4'

index.d.ts

@@ -0,0 +1,27 @@
+export interface DeferredPromise<ValueType> {
+	/**
+	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<ValueType>): 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<ValueType>;
+}
+
+/**
+Create a deferred promise.
+*/
+export default function pDefer<ValueType = unknown>(): DeferredPromise<
+	ValueType
+>;

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;

index.test-d.ts

@@ -0,0 +1,9 @@
+import {expectType} from 'tsd-check';
+import pDefer, {DeferredPromise} from '.';
+
+expectType<DeferredPromise<unknown>>(pDefer());
+expectType<DeferredPromise<string>>(pDefer<string>());
+
+pDefer<string>().resolve('foo');
+pDefer<string>().reject(new Error('foo'));
+expectType<Promise<string>>(pDefer<string>().promise);

license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (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.

package.json

@@ -10,13 +10,14 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-    "node": ">=4"
+		"node": ">=6"
 	},
 	"scripts": {
-    "test": "xo && ava"
+		"test": "xo && ava && tsd-check"
 	},
 	"files": [
-    "index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"promise",
@@ -32,10 +33,8 @@
 		"bluebird"
 	],
 	"devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  },
-  "xo": {
-    "esnext": true
+		"ava": "^1.3.1",
+		"tsd-check": "^0.5.0",
+		"xo": "^0.24.0"
 	}
 }

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.*

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);
 });