StreamBatch
Defined in: packages/client/src/circuits/stream-source.ts:20
One delivery from a stream, with the position that acknowledges it.
Properties
Section titled “Properties”envelopes
Section titled “envelopes”envelopes: readonly
StreamEnvelope[]
Defined in: packages/client/src/circuits/stream-source.ts:21
offset
Section titled “offset”offset:
string
Defined in: packages/client/src/circuits/stream-source.ts:28
The offset to resume from after THIS batch. Persist it with the applied rows in one transaction: persisted ahead, a crash loses the envelopes between; persisted behind, they are re-applied. The apply path is idempotent so the second is survivable and the first is not, which is why this rides the batch rather than being read off the stream afterwards.
upToDate
Section titled “upToDate”upToDate:
boolean
Defined in: packages/client/src/circuits/stream-source.ts:30
Whether THIS batch reached the tail of the stream as it stood when the server answered.