Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventStore

Abstract interface for an Event Store

Hierarchy

Index

Methods

Abstract bestEffortCount

  • bestEffortCount(): Promise<number>

Abstract chronologicalQuery

  • Retrieve commits from the store chronologically

    Parameters

    • params: object
      • Optional descending?: undefined | true | false
      • Optional exclusiveMax?: undefined | true | false
      • Optional exclusiveMin?: undefined | true | false
      • Optional filterAggregateTypes?: AggregateType[]
      • Optional group?: undefined | string
      • Optional limit?: undefined | number
      • Optional max?: string | Date
      • min: string | Date

    Returns StoreQueryResponse

Abstract commit

  • commit(commit: Commit): Promise<void>

Abstract createBatchMutator

Abstract getAggregateHeadCommit

Abstract getHeadCommit

  • getHeadCommit(chronologicalGroup?: undefined | string): Promise<Commit | null>
  • Get the most recent commit in the given chronological group

    Parameters

    • Optional chronologicalGroup: undefined | string

    Returns Promise<Commit | null>

Abstract queryAggregateCommits

  • Query the commits of an Aggregate instance

    Parameters

    • type: AggregateType
    • key: AggregateKey
    • Optional options: undefined | object
      • Optional consistentRead?: undefined | true | false
      • Optional descending?: undefined | true | false
      • Optional limit?: undefined | number
      • Optional maxTime?: Date | number
      • Optional maxVersion?: undefined | number
      • Optional minVersion?: undefined | number

    Returns StoreQueryResponse

Abstract scan

  • Scan store commits

    Parameters

    • Optional options: undefined | object
      • Optional capacityLimit?: undefined | number
      • Optional filterAggregateTypes?: string[]
      • Optional limit?: undefined | number
      • Optional segment?: undefined | number
      • Optional startKey?: any
      • Optional totalSegments?: undefined | number

    Returns StoreQueryResponse

Abstract scanAggregateInstances

Abstract setup

  • setup(): Promise<void>

Abstract teardown

  • teardown(): Promise<void>

Abstract toString

  • toString(): string

Generated using TypeDoc