Skip to content

Fix return type when throwOnTimeout: true passed to constructor #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix return type when throwOnTimeout: true passed to constructor #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5869e98
Fix return type when `throwOnTimeout: true` passed to constructor
Richienb Sep 8, 2025
df967b5
Better tests
Richienb Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions source/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type EventName = 'active' | 'idle' | 'empty' | 'add' | 'next' | 'completed' | 'e
/**
Promise queue with concurrency control.
*/
export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsType> = PriorityQueue, EnqueueOptionsType extends QueueAddOptions = QueueAddOptions> extends EventEmitter<EventName> { // eslint-disable-line @typescript-eslint/naming-convention, unicorn/prefer-event-target
export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsType> = PriorityQueue, EnqueueOptionsType extends QueueAddOptions = QueueAddOptions, OptionsType extends Options<QueueType, EnqueueOptionsType> = Options<QueueType, EnqueueOptionsType>> extends EventEmitter<EventName> { // eslint-disable-line @typescript-eslint/naming-convention, unicorn/prefer-event-target
readonly #carryoverConcurrencyCount: boolean;

readonly #isIntervalIgnored: boolean;
Expand Down Expand Up @@ -53,8 +53,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>) {
constructor(options?: OptionsType) {
super();

// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
Expand All @@ -66,7 +65,7 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
autoStart: true,
queueClass: PriorityQueue,
...options,
} as Options<QueueType, EnqueueOptionsType>;
} as OptionsType;

if (!(typeof options.intervalCap === 'number' && options.intervalCap >= 1)) {
throw new TypeError(`Expected \`intervalCap\` to be a number from 1 and up, got \`${options.intervalCap?.toString() ?? ''}\` (${typeof options.intervalCap})`);
Expand Down Expand Up @@ -275,7 +274,7 @@ 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: {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<OptionsType extends {throwOnTimeout: true} ? TaskResultType : TaskResultType | void>;
async add<TaskResultType>(function_: Task<TaskResultType>, options: Partial<EnqueueOptionsType> = {}): Promise<TaskResultType | void> {
// In case `id` is not defined.
options.id ??= (this.#idAssigner++).toString();
Expand Down Expand Up @@ -333,12 +332,12 @@ export default class PQueue<QueueType extends Queue<RunFunction, EnqueueOptionsT
*/
async addAll<TaskResultsType>(
functions: ReadonlyArray<Task<TaskResultsType>>,
options?: {throwOnTimeout: true} & Partial<Exclude<EnqueueOptionsType, 'throwOnTimeout'>>,
options: {throwOnTimeout: true} & Exclude<EnqueueOptionsType, 'throwOnTimeout'>,
): Promise<TaskResultsType[]>;
async addAll<TaskResultsType>(
functions: ReadonlyArray<Task<TaskResultsType>>,
options?: Partial<EnqueueOptionsType>,
): Promise<Array<TaskResultsType | void>>;
): Promise<Array<OptionsType extends {throwOnTimeout: true} ? TaskResultsType : TaskResultsType | void>>;
async addAll<TaskResultsType>(
functions: ReadonlyArray<Task<TaskResultsType>>,
options?: Partial<EnqueueOptionsType>,
Expand Down
14 changes: 14 additions & 0 deletions test-d/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ const queue = new PQueue();

expectType<Promise<string | void>>(queue.add(async () => '🦄'));
expectType<Promise<string>>(queue.add(async () => '🦄', {throwOnTimeout: true}));

expectType<Promise<Array<string | void>>>(queue.addAll([async () => '🦄', async () => '🦄']));
expectType<Promise<string[]>>(queue.addAll([async () => '🦄', async () => '🦄'], {throwOnTimeout: true}));

const queue2 = new PQueue({throwOnTimeout: true});

expectType<Promise<string>>(queue2.add(async () => '🦄'));
expectType<Promise<string[]>>(queue2.addAll([async () => '🦄', async () => '🦄']));

expectType<Promise<string | void>>(queue2.add(async () => '🦄', {throwOnTimeout: false}));
expectType<Promise<string[] | void>>(queue2.addAll([async () => '🦄', async () => '🦄'], {throwOnTimeout: false}));

expectType<Promise<string>>(queue.add(async () => '🦄', {throwOnTimeout: true}));
expectType<Promise<string[]>>(queue.addAll([async () => '🦄', async () => '🦄'], {throwOnTimeout: true}));
Loading