Skip to content
delta-base docs

ReadStreamResult

API reference for ReadStreamResult

@delta-base/toolkit

Type Alias: ReadStreamResult<EventType, StreamVersion>

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

ReadStreamResult<EventType, StreamVersion> = object

Result of reading events from a stream

Type Parameters

Section titled “Type Parameters”

EventType

Section titled “EventType”

EventType extends Event = AnyEvent

StreamVersion

Section titled “StreamVersion”

StreamVersion = StreamPosition

Properties

Section titled “Properties”

currentStreamVersion

Section titled “currentStreamVersion”

currentStreamVersion: StreamVersion

events

Section titled “events”

events: ReadEvent<EventType>[]

streamExists

Section titled “streamExists”

streamExists: boolean