Strands Agents Typescript SDK
    Preparing search index...

    Interface ToolStreamEvent

    Event yielded during tool execution to report streaming progress. Tools can yield zero or more of these events before returning the final ToolResult.

    const streamEvent = new ToolStreamEvent({
      data: 'Processing step 1...'
    })

    // Or with structured data
    const streamEvent = new ToolStreamEvent({
      data: { progress: 50, message: 'Halfway complete' }
    })
    interface ToolStreamEvent {
        type: "toolStreamEvent";
        data?: unknown;
    }

    Implements

    Index

    Properties

    type data?

    Properties

    type: "toolStreamEvent" = ...

    Discriminator for tool stream events.

    data?: unknown

    Caller-provided data for the progress update. Can be any type of data the tool wants to report.

    Settings

    Member Visibility

    On This Page

    Properties