TurnHandle

Extends

• Promise<TurnResult>

Properties

events

readonly events: AsyncIterable<StreamPart>;

---

runId

readonly runId: Promise<string>;

Resolves as soon as the run is opened — before the turn body finishes — so a caller minting kind: 'flow' can persist the id it must resume with even if the turn later throws.

Methods

cancel()

cancel(reason?): void;

Parameters

Parameter	Type
reason?	string

Returns

void

---

toResponseStream()

toResponseStream(format?): ReadableStream;

Parameters

Parameter	Type
format?	"sse" | "ndjson"

Returns

ReadableStream

---

toUIMessageStreamResponse()

toUIMessageStreamResponse(opts?): Response;

Parameters

Parameter	Type
opts?	{ sessionId?: string; }
opts.sessionId?	string

Returns

Response