@monstermann/fn/dist/promise/queue.d.ts

A utility library for TypeScript.

//#region src/promise/queue.d.ts
interface Queue {
  add: <T>(fn: () => T) => Promise<Awaited<T>>;
  idle: () => Promise<void>;
}
type QueueOptions = number | {
  concurrency: number;
};
/**
 * `queue(options)`
 *
 * Creates a queue that limits concurrent execution of tasks.
 *
 * ```ts
 * const taskQueue = queue({ concurrency: 2 });
 * const taskQueue2 = queue(2); // shorthand
 *
 * const results = await Promise.all([
 *     // At most 2 fetch calls are executed at any time
 *     taskQueue.add(() => fetchData(1)),
 *     taskQueue.add(() => fetchData(2)),
 *     taskQueue.add(() => fetchData(3)),
 * ]);
 *
 * // Wait for queue to become idle
 */
declare function queue(options: QueueOptions): Queue;
//#endregion
export { queue };