Fix typings

Fixes #175

Signed-off-by: Richie Bendall <[email protected]>

Author: Richienb

package.json

@@ -12,7 +12,7 @@
 	},
 	"scripts": {
 		"build": "del-cli dist && tsc",
-		"test": "xo && ava",
+		"test": "xo && ava && del-cli dist && tsc && tsd",
 		"bench": "node --loader=ts-node/esm bench.ts",
 		"prepublishOnly": "del-cli dist && tsc"
 	},
@@ -59,6 +59,7 @@
 		"random-int": "^3.0.0",
 		"time-span": "^5.0.0",
 		"ts-node": "^10.9.1",
+		"tsd": "^0.25.0",
 		"typescript": "^4.8.4",
 		"xo": "^0.44.0"
 	},

source/index.ts

@@ -55,6 +55,7 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
 	*/
 	timeout?: number;
 
+	// TODO: The `throwOnTimeout` option should affect the return types of `add()` and `addAll()`
 	constructor(options?: Options<QueueType, EnqueueOptionsType>) {
 		super();
 
@@ -237,8 +238,8 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
 	/**
 	Adds a sync or async task to the queue. Always returns a promise.
 	*/
-	async add<TaskResultType>(function_: Task<TaskResultType>, options?: Partial<EnqueueOptionsType>): Promise<TaskResultType | void>;
 	async add<TaskResultType>(function_: Task<TaskResultType>, options: {throwOnTimeout: true} & Exclude<EnqueueOptionsType, 'throwOnTimeout'>): Promise<TaskResultType>;
+	async add<TaskResultType>(function_: Task<TaskResultType>, options?: Partial<EnqueueOptionsType>): Promise<TaskResultType | void>;
 	async add<TaskResultType>(function_: Task<TaskResultType>, options: Partial<EnqueueOptionsType> = {}): Promise<TaskResultType | void> {
 		options = {
 			timeout: this.timeout,
@@ -295,14 +296,14 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
 
 	@returns A promise that resolves when all functions are resolved.
 	*/
-	async addAll<TaskResultsType>(
-		functions: ReadonlyArray<Task<TaskResultsType>>,
-		options?: Partial<EnqueueOptionsType>,
-	): Promise<Array<TaskResultsType | void>>;
 	async addAll<TaskResultsType>(
 		functions: ReadonlyArray<Task<TaskResultsType>>,
 		options?: {throwOnTimeout: true} & Partial<Exclude<EnqueueOptionsType, 'throwOnTimeout'>>,
 	): Promise<TaskResultsType[]>
+	async addAll<TaskResultsType>(
+		functions: ReadonlyArray<Task<TaskResultsType>>,
+		options?: Partial<EnqueueOptionsType>,
+	): Promise<Array<TaskResultsType | void>>;
 	async addAll<TaskResultsType>(
 		functions: ReadonlyArray<Task<TaskResultsType>>,
 		options?: Partial<EnqueueOptionsType>,

test-d/index.test-d.ts

@@ -0,0 +1,7 @@
+import {expectType} from 'tsd';
+import PQueue from '../source/index.js';
+
+const queue = new PQueue();
+
+expectType<Promise<string | void>>(queue.add(async () => '🦄'));
+expectType<Promise<string>>(queue.add(async () => '🦄', {throwOnTimeout: true}));