Event | Stalagmite

This is the event interface

example

export interface CounterInitiated extends Event {
  name: "CounterInitiated";
  version: 1;
  payload: {
    counterId: string;
    count: number;
  };
}

Hierarchy

Event

Index

Properties

commandId
entityId
metadata
name
payload
sequence
version

Properties

commandId

commandId: string

The command id that has generated this event.

entityId

entityId: string

This is the aggregate id.

metadata

metadata: unknown

The metadata of your event.

name

name: string

The name of the event

payload

payload: unknown

The payload of your event.

sequence

sequence: number

It's the place of the event in the history of the aggregate.

version

version: number

The version of the event. Used to track schemas evolution of your events.