Class EventBridgeEventBus

AWS EventBridge bus connection.

Publishes each event as a PutEvents entry (Source, DetailType, Detail) on the configured event bus. The domain emits; EventBridge rules fan out to targets (Lambda, SQS, ...), where the listener side (the light key-router from @stone-js/router, via @BusListener) routes the event to its @OnBusEvent handler. @aws-sdk/client-eventbridge is imported lazily as an optional peer.

Implements

EventBusConnection

Index

Constructors

Properties

Methods

Constructors

constructor

new EventBridgeEventBus(options: EventBridgeOptions): EventBridgeEventBus
Parameters
- options: EventBridgeOptions
  The connection options.
Returns EventBridgeEventBus

Properties

`Readonly`name

name: string

A human-readable name (e.g. local, cloud, eventbridge).

Methods

emit

emit<T = unknown>(
    name: string,
    payload?: T,
    options?: EmitOptions,
): Promise<void>
Type Parameters
- T = unknown
Parameters
- name: string
- Optionalpayload: T
- options: EmitOptions = {}
Returns Promise<void>

Inherit Doc

Implementation of EventBusConnection.emit

`Static`create

create(options: EventBridgeOptions): EventBridgeEventBus
Create an EventBridge connection.
Parameters
- options: EventBridgeOptions
  The connection options.
Returns EventBridgeEventBus
A new connection.