emittableevent

EmittableEvent

EmittableEvent is an opinionated abstraction class for generating rich EventBridge events.

// Your own event class
class MyEvent extends EmittableEvent {
  // Do something here if you want, else just leave it as is!
}

// Convenience utility to produce required static metadata
const getMetadataConfig = (version = 1): MetadataConfigInput => {
  return {
    version,
    eventType: 'DomainEvent',
    domain: 'MyDomain',
    system: 'MySystem',
    service: 'MyService',
    team: 'MyTeam',
    hostPlatform: 'aws',
    owner: 'Sam Person',
    jurisdiction: 'eu'
  };
};

// Input for actually creating the event
const eventInput = {
  eventName: 'Created',
  eventBusName: 'MyEventBus',
  data: {
    something: 'some value here if you want'
  },
  metadataConfig: getMetadataConfig()
};

// Create the event
const event = new CreatedEvent(eventInput, requestContext);

// ...and here's the actual full body of the event
console.log(event.get());