Type alias ToPersistEvent

ToPersistEvent: {
    data: Record<string, any>;
    id?: EventId;
    identifier: Record<string, any>;
    timestamp?: Date;
    type: string;
}

This is the structure of an event to give to the appendEvent function

Example

 const sourcingEvent: ToPersistEvent = {
  type: "course-created",
   data: {
     courseId: "6c811e1c-a441-4dc0-af89-b92f6e1784ed",
     name: "Maths",
   },
   identifier: {
     courseId: "6c811e1c-a441-4dc0-af89-b92f6e1784ed",
   },
 }

 await sorci.appendEvent({
   sourcingEvent
 }),

Type declaration

  • data: Record<string, any>
  • Optional id?: EventId

    Remarks

    The id of the event. If not provided, it will be generated automatically

  • identifier: Record<string, any>
  • Optional timestamp?: Date

    Remarks

    The creation date of the event. If not provided will be generated automatically

  • type: string

Settings

Member Visibility

Theme

Generated using TypeDoc