Skip to content

GramIO API Reference / @gramio/composer/dist / EventQueue

Class: EventQueue<T> ​

Defined in: composer/index.d.ts:219

Concurrent event queue with graceful shutdown support. Processes events in parallel (like an event loop), not sequentially.

Type Parameters ​

Type Parameter
T

Constructors ​

Constructor ​

new EventQueue<T>(handler): EventQueue<T>

Defined in: composer/index.d.ts:225

Parameters ​

ParameterType
handler(event) => Promise<unknown>

Returns ​

EventQueue<T>

Accessors ​

isActive ​

Get Signature ​

get isActive(): boolean

Defined in: composer/index.d.ts:232

Returns ​

boolean


pending ​

Get Signature ​

get pending(): number

Defined in: composer/index.d.ts:230

Returns ​

number


queued ​

Get Signature ​

get queued(): number

Defined in: composer/index.d.ts:231

Returns ​

number

Methods ​

add() ​

add(event): void

Defined in: composer/index.d.ts:226

Parameters ​

ParameterType
eventT

Returns ​

void


addBatch() ​

addBatch(events): void

Defined in: composer/index.d.ts:227

Parameters ​

ParameterType
eventsT[]

Returns ​

void


onIdle() ​

onIdle(): Promise<void>

Defined in: composer/index.d.ts:229

Returns ​

Promise<void>


stop() ​

stop(timeout?): Promise<void>

Defined in: composer/index.d.ts:228

Parameters ​

ParameterType
timeout?number

Returns ​

Promise<void>