Class StreamWriter

A writer of one of the run's streams (ctx.stream).

Index

Properties

closed name recordedCount

Methods

append close recorded

Properties

`Readonly`closed

closed: boolean

The stream was complete when it was opened (an earlier attempt of the step completed it: appends are dropped).

`Readonly`name

name: string

`Readonly`recordedCount

recordedCount: number

Chunks the step's earlier attempts recorded (0 on a first attempt and in workflow code).

Methods

append

append(value: unknown): void
Appends a chunk: a Uint8Array as bytes, anything else as JSON. Never waits for the disk.
Parameters
- value: unknown
Returns void

close

close(): void

Completes the stream: readers end once they have every chunk.

Returns void

recorded

recorded<T = unknown>(): T[]
The chunks the step's earlier attempts recorded (after a crash, the durable ones): continue after them, so readers see no chunk twice.
Type Parameters
- T = unknown
Returns T[]