AggregateStreamOptions
API reference for AggregateStreamOptions
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
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
ReadEvent<EventType>
Returns
Section titled “Returns”State
initialState()
Section titled “initialState()”initialState: () =>
State
Returns
Section titled “Returns”State
optionalread:ReadStreamOptions<StreamVersion>