Skip to content
delta-base docs

AggregateStreamOptions

API reference for AggregateStreamOptions

@delta-base/toolkit

Type Alias: AggregateStreamOptions<State, EventType, StreamVersion>

Section titled “Type Alias: AggregateStreamOptions<State, EventType, StreamVersion>”

AggregateStreamOptions<State, EventType, StreamVersion> = object

Options for aggregating events into state

Type Parameters

Section titled “Type Parameters”

State

Section titled “State”

State

EventType

Section titled “EventType”

EventType extends Event

StreamVersion

Section titled “StreamVersion”

StreamVersion = StreamPosition

Properties

Section titled “Properties”

evolve()

Section titled “evolve()”

evolve: (currentState, event) => State

Parameters

Section titled “Parameters”
currentState
Section titled “currentState”

State

event
Section titled “event”

ReadEvent<EventType>

Returns

Section titled “Returns”

State

initialState()

Section titled “initialState()”

initialState: () => State

Returns

Section titled “Returns”

State

read?

Section titled “read?”

optional read: ReadStreamOptions<StreamVersion>