Type Alias Event<T, D>

The common event structure, published by notification-services

Example usage:

type MyEvent = Event<"myDomain.myDomainObject.someEvent", {
  field1: string,
  field2: Date
}>

type Event<T extends string, D extends object> = {
    createdAt?: Date;
    customerId: string;
    data: SimplifyDeep<D>;
    event: T;
}

T extends string
The type of the event, should be unique within its domain
D extends object
The event data for this specific event type and domain. It must be (de)seriable to/from JSON.

Properties

createdAt?: Date

The timestamp of when the publisher created the event. Defaults to current time.

customerId: string

B2B Customer ID

data: SimplifyDeep<D>

Functional data related to event

event: T

Event type, in the format:

<domain>.<entity>.<event>, e.g. deposit.cashDepositRequest.statusUpdated