forge/queue

The event-driven task Queue and its supporting types.

Other

A unit of work the Queue can run.

Properties

id (string) — Stable identifier for the task.
priority (Priority, optional, default: "Priority.NORMAL") — Relative scheduling weight.
run (TaskHandler) — The function invoked when the task is scheduled.

Type

Object

The function a Task runs when scheduled.

Parameters

Returns

static

Maximum concurrency the queue will ever allow, regardless of options.

Type

number

static

Extends: EventEmitter

An ordered, event-driven task runner.

Queue extends Node's EventEmitter, so the inheritance chain and the emitted events both show up in the generated page.

Tasks pushed after Queue#clear runs are rejected — clearing aborts the in-flight signal.

Parameters

options (Object, optional, default: "{}") — Queue configuration.
- options.concurrency (number, optional, default: 1) — How many tasks run at once (clamped to MAX_CONCURRENCY).
- options.autoStart (boolean, optional, default: true) — Start draining as soon as a task is pushed.

Fires

Listens

Example

Draining a queue

CODE

const q = new Queue({ concurrency: 2 });
q.on('drain', () => console.log('done'));
q.push({ id: 't1', run: async () => doWork() });
await q.drain();