Class BufferedTextStream

Batches text chunks during one asynchronous Step invocation.

Implements

StepOutputFinalizer

Index

Constructors

Methods

cancelStepOutput finalizeStepOutput write

Constructors

constructor

new BufferedTextStream(
    stream: Stream<string>,
    context: Context,
    flushIntervalMs: number,
    maxBufferedBytes: number,
): BufferedTextStream
Creates a writer from validated invocation-owned components.
Parameters
- stream: Stream<string>
  Registered string Stream receiving emitted batches.
- context: Context
  Current asynchronous Step Context.
- flushIntervalMs: number
  Positive one-shot interval in milliseconds.
- maxBufferedBytes: number
  Positive soft UTF-8 threshold.
Returns BufferedTextStream

Methods

cancelStepOutput

cancelStepOutput(): void
Discards buffered text and stops the timer after invocation cancellation.

Returns void
Implementation of StepOutputFinalizer.cancelStepOutput

finalizeStepOutput

finalizeStepOutput(): void
Flushes the tail and closes this writer during invocation finalization.

Returns void
Implementation of StepOutputFinalizer.finalizeStepOutput

write

write(value: string): void
Appends one chunk without modification and flushes after crossing the soft size threshold.
Parameters
- value: string
  Text to append; an empty string is ignored.
Returns void
Throws
Error if the invocation finished or an earlier background flush failed.