ToolStreamEvent

Defined in: src/tools/tool.ts:58

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

Example

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

// Or with structured data
const streamEvent = new ToolStreamEvent({
  data: { progress: 50, message: 'Halfway complete' }
})

Implements

• ToolStreamEventData

Constructors

Constructor

new ToolStreamEvent(eventData): ToolStreamEvent;

Defined in: src/tools/tool.ts:70

Parameters

Parameter	Type
eventData	{ data?: unknown; }
eventData.data?	unknown

Returns

ToolStreamEvent

Properties

type

readonly type: "toolStreamEvent";

Defined in: src/tools/tool.ts:62

Discriminator for tool stream events.

Implementation of

ToolStreamEventData.type

---

data?

readonly optional data?: unknown;

Defined in: src/tools/tool.ts:68

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

Implementation of

ToolStreamEventData.data