Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Projection

Hierarchy

  • Projection

Index

Constructors

constructor

Properties

aggregateClasses

aggregateClasses: object

Type declaration

Optional dependencies

dependencies: undefined | object

Used to guarantee order of event processing while optimizing for parallel processing

maxBatchSize

maxBatchSize: number = Infinity

metaStore

metaStore: MetaStore

name

name: string

processEvents

processEvents: function

Type declaration

Methods

commitIsProcessed

  • commitIsProcessed(commit: Commit, options?: undefined | object): Promise<boolean>
  • Parameters

    • commit: Commit
    • Optional options: undefined | object
      • Optional backoffExponent?: undefined | number
      • Optional initialDelay?: undefined | number
      • Optional maxDelay?: undefined | number
      • Optional timeout?: undefined | number

    Returns Promise<boolean>

getHeadSortKey

  • getHeadSortKey(fail?: boolean): Promise<any>

setHeadSortKey

  • setHeadSortKey(sortKey: string): Promise<void>

setup

  • setup(params: object): Promise<void>
  • Ready projection target and set initial headSortKey in MetaStore

    Parameters

    • params: object
      • startsAt: Date | string

    Returns Promise<void>

teardown

  • teardown(): Promise<void>

whenSortKeyReached

  • whenSortKeyReached(sortKey: string, options?: object): Promise<boolean>
  • Parameters

    • sortKey: string
    • Default value options: object = {}
      • Optional backoffExponent?: undefined | number
      • Optional initialDelay?: undefined | number
      • Optional maxDelay?: undefined | number
      • Optional timeout?: undefined | number

    Returns Promise<boolean>

Generated using TypeDoc