Interface StreamOptions

Options for streaming execution

interface StreamOptions {
    onChunk?: (chunk: StreamChunk<unknown>) => void;
    onComplete?: (result: AgentResult<unknown>) => void;
    onError?: (error: Error) => void;
    signal?: AbortSignal;
}

Properties

onChunk? onComplete? onError? signal?

Properties

OptionalonChunk

onChunk?: (chunk: StreamChunk<unknown>) => void

Callback invoked for each chunk

OptionalonComplete

onComplete?: (result: AgentResult<unknown>) => void

Callback invoked when streaming completes

OptionalonError

onError?: (error: Error) => void

Callback invoked when streaming encounters an error

Optionalsignal

signal?: AbortSignal

Abort signal to cancel streaming

Settings

Member Visibility

On This Page

Properties