Refactor TypeScript definition to CommonJS compatible export (#17)

index.d.ts

@@ -1,43 +1,57 @@
-export class AbortError extends Error {
+declare class AbortErrorClass extends Error {
 	readonly name: 'AbortError';
 
 	/**
-	 * Abort pending execution. All unresolved promised are rejected with a `AbortError` error.
-	 */
+	Abort pending execution. All unresolved promised are rejected with a `AbortError` error.
+	*/
 	constructor();
 }
 
-export type ThrottledFunction<Arguments extends unknown[], Return> = ((
-	...arguments: Arguments
-) => Promise<Return>) & {
+declare namespace pThrottle {
+	type ThrottledFunction<Arguments extends unknown[], Return> = ((
+		...arguments: Arguments
+	) => Promise<Return>) & {
+		/**
+		Abort pending executions. All unresolved promises are rejected with a `pThrottle.AbortError` error.
+		*/
+		abort(): void;
+	};
+
+	type AbortError = AbortErrorClass;
+}
+
+declare const pThrottle: {
 	/**
-	 * Abort pending executions. All unresolved promises are rejected with a `pThrottle.AbortError` error.
-	 */
-	abort(): void;
+	[Throttle](https://css-tricks.com/debouncing-throttling-explained-examples/) promise-returning/async/normal functions.
+
+	@param fn - Promise-returning/async function or a normal function.
+	@param limit - Maximum number of calls within an `interval`.
+	@param interval - Timespan for `limit` in milliseconds.
+	@returns A throttled version of `fn`.
+
+	@example
+	```
+	import pThrottle from 'p-throttle';
+
+	const throttled = pThrottle(async index => {
+		return index * 2;
+	}, 2, 1000);
+
+	for (let i = 1; i <= 6; i++) {
+		throttled(i).then(console.log);
+	}
+	```
+	*/
+	<Arguments extends unknown[], Return>(
+		fn: (...arguments: Arguments) => PromiseLike<Return> | Return,
+		limit: number,
+		interval: number
+	): pThrottle.ThrottledFunction<Arguments, Return>;
+
+	AbortError: typeof AbortErrorClass;
+
+	// TODO: Remove this for the next major release
+	default: typeof pThrottle;
 };
 
-/**
- * [Throttle](https://css-tricks.com/debouncing-throttling-explained-examples/) promise-returning/async/normal functions.
- *
- * @param fn - Promise-returning/async function or a normal function.
- * @param limit - Maximum number of calls within an `interval`.
- * @param interval - Timespan for `limit` in milliseconds.
- * @returns A throttled version of `fn`.
- *
- * @example
- *
- * import pThrottle from 'p-throttle';
- *
- * const throttled = pThrottle(async index => {
- * 	return index * 2;
- * }, 2, 1000);
- *
- * for (let i = 1; i <= 6; i++) {
- * 	throttled(i).then(console.log);
- * }
- */
-export default function<Arguments extends unknown[], Return>(
-	fn: (...arguments: Arguments) => PromiseLike<Return> | Return,
-	limit: number,
-	interval: number
-): ThrottledFunction<Arguments, Return>;
+export = pThrottle;

index.js

@@ -60,5 +60,6 @@ const pThrottle = (fn, limit, interval) => {
 };
 
 module.exports = pThrottle;
+// TODO: Remove this for the next major release
 module.exports.default = pThrottle;
 module.exports.AbortError = AbortError;

index.test-d.ts

@@ -1,19 +1,12 @@
-import {expectType} from 'tsd-check';
-import pThrottle, {AbortError, ThrottledFunction} from '.';
+import {expectType} from 'tsd';
+import pThrottle = require('.');
+import {AbortError, ThrottledFunction} from '.';
 
-const throttledUnicorn = pThrottle(
-	(index: string) => '🦄',
-	1,
-	1000
-);
+const throttledUnicorn = pThrottle((index: string) => '🦄', 1, 1000);
 
-const throttledLazyUnicorn = pThrottle(
-	async (index: string) => '🦄',
-	1,
-	1000
-);
+const throttledLazyUnicorn = pThrottle(async (index: string) => '🦄', 1, 1000);
 
-expectType<Error>(new AbortError());
+expectType<AbortError>(new AbortError());
 
 expectType<ThrottledFunction<[string], string>>(throttledUnicorn);
 expectType<ThrottledFunction<[string], string>>(throttledLazyUnicorn);

package.json

@@ -13,7 +13,7 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -40,11 +40,11 @@
 		"bluebird"
 	],
 	"devDependencies": {
-		"ava": "^1.2.1",
+		"ava": "^1.4.1",
 		"delay": "^4.1.0",
 		"in-range": "^1.0.0",
 		"time-span": "^2.0.0",
-		"tsd-check": "^0.3.0",
+		"tsd": "^0.7.2",
 		"xo": "^0.24.0"
 	}
 }