Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Commit

Represents an aggregate changeset consisting of one or more events

Hierarchy

  • Commit

Index

Constructors

constructor

  • new Commit(attributes: object): Commit
  • Parameters

    • attributes: object

      Commit attributes

      • aggregateKey: AggregateKey
      • aggregateType: AggregateType

        Hey

      • aggregateVersion: number
      • Optional chronologicalGroup?: undefined | string
      • events: Event[]
      • Optional expiresAt?: undefined | number
      • Optional sortKey?: undefined | string
      • Optional storeKey?: undefined | __type
      • Optional timestamp?: Timestamp | string | Date

    Returns Commit

Properties

aggregateKey

aggregateKey: AggregateKey

aggregateType

aggregateType: AggregateType

aggregateVersion

aggregateVersion: number

chronologicalGroup

chronologicalGroup: string

events

events: Event[]

Optional expiresAt

expiresAt: undefined | number

timestamp

timestamp: Timestamp

Accessors

sortKey

  • get sortKey(): string

storeKey

  • get storeKey(): __type | undefined

Methods

toJSON

  • toJSON(): object
  • Returns object

    • aggregateKey: string
    • aggregateType: string
    • aggregateVersion: number
    • chronologicalGroup: string
    • events: Event[]
    • expiresAt: undefined | number
    • timestamp: number

Static hasSameKey

Generated using TypeDoc