Skip to content

ReadStreamOptions

API reference for ReadStreamOptions

@delta-base/toolkit


Type Alias: ReadStreamOptions<StreamVersion>

Section titled “Type Alias: ReadStreamOptions<StreamVersion>”

ReadStreamOptions<StreamVersion> = { from: StreamVersion; } | { to: StreamVersion; } | { from: StreamVersion; maxCount?: number; } | { expectedStreamVersion: ExpectedStreamVersion<StreamVersion>; } & object

Options for reading events from a stream

optional expectedStreamVersion: ExpectedStreamVersion<StreamVersion>

StreamVersion = StreamPosition