Type alias Client

Type declaration

• agg: (<S, E>(factory, query) => Promise<AggResult<S>>)

  • • <S, E>(factory, query): Promise<AggResult<S>>

    • Aggregates projection records

      Type Parameters

      • S extends State

      • E extends Messages

      Parameters

      • factory: ProjectorFactory<S, E>

        the projector factory

      • query: AggQuery<S>

        the aggregate query

      Returns Promise<AggResult<S>>

      the aggregate results

• command: (<S, C, E, N>(factory, name, data, target) => Promise<Snapshot<S, E> | undefined>)

  • • <S, C, E, N>(factory, name, data, target): Promise<Snapshot<S, E> | undefined>

    • Handles command

      Type Parameters

      • S extends State

      • C extends Messages

      • E extends Messages

      • N extends keyof C & string

      Parameters

      • factory: CommandHandlerFactory<S, C, E>

        the command handler factory (aggregate or system)

      • name: N

        the command name

      • data: Readonly<C[N]>

        the command payload

      • target: CommandTarget

        the command target

      Returns Promise<Snapshot<S, E> | undefined>

      last snapshot produced by command

• event: (<S, C, E>(factory, event) => Promise<EventResponse<S, C>>)

  • • <S, C, E>(factory, event): Promise<EventResponse<S, C>>

    • Validates and handles event message

      Type Parameters

      • S extends State

      • C extends Messages

      • E extends Messages

      Parameters

      • factory: EventHandlerFactory<S, C, E>

        the event handler factory (policy, process manager, or projector)

      • event: CommittedEvent<E>

        the committed event to be handled

      Returns Promise<EventResponse<S, C>>

      response, including command or projection side effects

• invoke: (<P, S, C, E>(factory, payload) => Promise<Snapshot<S, E> | undefined>)

  • • <P, S, C, E>(factory, payload): Promise<Snapshot<S, E> | undefined>

    • Invokes command through adapter

      Type Parameters

      • P extends State

      • S extends State

      • C extends Messages

      • E extends Messages

      Parameters

      • factory: CommandAdapterFactory<P, C>

        adapter factory

      • payload: P

        message payload

      Returns Promise<Snapshot<S, E> | undefined>

      last snapshot produced by command

• load: (<S, C, E>(reducible, stream, callback?) => Promise<Snapshot<S, E>>)

  • • <S, C, E>(reducible, stream, callback?): Promise<Snapshot<S, E>>

    • Loads current aggregate snapshot

      Type Parameters

      • S extends State

      • C extends Messages

      • E extends Messages

      Parameters

      • reducible: AggregateFactory<S, C, E>

      • stream: string

        the aggregate stream id

      • Optional callback: ((snapshot) => void)

        optional reduction predicate to act on each snapshot

        • • (snapshot): void

          • Parameters

            • snapshot: Snapshot<S, E>

            Returns void

      Returns Promise<Snapshot<S, E>>

      current model state

• project: (<S, E>(factory, events) => Promise<ProjectionResults>)

  • • <S, E>(factory, events): Promise<ProjectionResults>

    • Projects events into a projection

      Type Parameters

      • S extends State

      • E extends Messages

      Parameters

      • factory: ProjectorFactory<S, E>

        the projector factory

      • events: CommittedEvent<E>[]

        the committed events to project

      Returns Promise<ProjectionResults>

      the projection

• query: ((query, callback?) => Promise<{
      count: number;
      first?: CommittedEvent;
      last?: CommittedEvent;
  }>)

  • • (query, callback?): Promise<{
          count: number;
          first?: CommittedEvent;
          last?: CommittedEvent;
      }>

    • Queries the store - all streams

      Parameters

      • query: AllQuery

        query parameters

      • Optional callback: ((event) => void)

        optional event predicate

        • • (event): void

          • Parameters

            • event: CommittedEvent

            Returns void

      Returns Promise<{
          count: number;
          first?: CommittedEvent;
          last?: CommittedEvent;
      }>

      query summary

• read: (<S, E>(factory, query) => Promise<ProjectionRecord<S>[]>)

  • • <S, E>(factory, query): Promise<ProjectionRecord<S>[]>

    • Reads projection records by id or query

      Type Parameters

      • S extends State

      • E extends Messages

      Parameters

      • factory: ProjectorFactory<S, E>

        the projector factory

      • query: string | string[] | ProjectionQuery<S>

        the record id(s) or a query

      Returns Promise<ProjectionRecord<S>[]>

      the matched records