Class EventQueue

A debounced, rate-limited, concurrent event queue.

Index

Constructors

Methods

drain enqueue pause process resume waitForIdleWorkers

Constructors

constructor

new EventQueue(options: EventQueueOptions): EventQueue
Create an event queue.
Parameters
- options: EventQueueOptions
  Queue options.
Returns EventQueue
- Defined in packages/service/src/queue/index.ts:71

Methods

drain

drain(): Promise<void>
Wait for the queue to become idle (no pending debounces, no queued items, no active work).

Returns Promise<void>
A promise that resolves when the queue is drained.
- Defined in packages/service/src/queue/index.ts:131

enqueue

enqueue(event: WatchEvent, fn: ProcessFn): void
Enqueue an event, debounced per path+priority.
Parameters
- event: WatchEvent
  The watch event.
- fn: ProcessFn
  The processing function to invoke when dequeued.
Returns void
- Defined in packages/service/src/queue/index.ts:84

pause

pause(): void
Pause processing events. Events can still be enqueued but will not be processed.

Returns void
- Defined in packages/service/src/queue/index.ts:114

process

process(): void
Start processing events.

Returns void
- Defined in packages/service/src/queue/index.ts:106

resume

resume(): void
Resume processing events.

Returns void
- Defined in packages/service/src/queue/index.ts:121

waitForIdleWorkers

waitForIdleWorkers(): Promise<void>
Wait until there is no in-flight work.

Unlike drain, this does NOT wait for debounced or queued items to be empty. It's useful when you need to temporarily quiesce outgoing work without losing or rejecting new enqueues.

Returns Promise<void>
- Defined in packages/service/src/queue/index.ts:145