Class EventQueue

Event queue class.

Consolidate event entries and then send them all in a single request at the next process tick. This greatly reduces number of API requests in case of batch requests, i.e. listing multiple entities in same GraphQL request.

Hierarchy

  • EventQueue

Constructors

constructor

Properties

_eventBus _nextPromise? _nextReject? _nextResolve? _promise? _queue _reject? _resolve? _runtimeConfig _state

Methods

_runRequest _transitionToQueued enqueue

Constructors

constructor

Properties

Protected _eventBus

_eventBus: EventBridge

Protected Optional _nextPromise

_nextPromise?: Promise<void>

Protected Optional _nextReject

_nextReject?: ((reason?: any) => void)

Type declaration

    • (reason?: any): void

    • Parameters

      • Optional reason: any

      Returns void

Protected Optional _nextResolve

_nextResolve?: ((value: void | PromiseLike<void>) => void)

Type declaration

    • (value: void | PromiseLike<void>): void

    • Parameters

      • value: void | PromiseLike<void>

      Returns void

Protected Optional _promise

_promise?: Promise<void>

Protected _queue

_queue: PutEventsRequestEntry[] = []

Protected Optional _reject

_reject?: ((reason?: any) => void)

Type declaration

    • (reason?: any): void

    • Parameters

      • Optional reason: any

      Returns void

Protected Optional _resolve

_resolve?: ((value: void | PromiseLike<void>) => void)

Type declaration

    • (value: void | PromiseLike<void>): void

    • Parameters

      • value: void | PromiseLike<void>

      Returns void

Protected _runtimeConfig

_runtimeConfig: RuntimeConfig

Protected _state

_state: EventQueueState = EventQueueState.idle

Methods

Private _runRequest

  • _runRequest(): void
  • Private

    Puts queued events to AWS EventBridge.

    This method is a process.nextTick callback and should never be called directly.

    Returns void

Private _transitionToQueued

  • _transitionToQueued(): void
  • Private

    Transitions to a queued state.

    Creates new Promise (or replaces it with the one which was already promised to someone), adds new process.nextTick handler and updates the internal state.

    Returns void

enqueue

  • Adds new event to a queue.

    Returns

    • A Promise which is resolved when a given event is pushed to the message bus.

    Parameters

    • source: string

      AWS EventBridge event source.

    • eventDetailType: string

      AWS EventBridge event detail type.

    • eventData: object

      Event data.

    Returns undefined | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc