Interface: DelegateStream

A delegate stream with lifecycle control.

Returned by client.delegateStream(). Iterate events to consume SSE events; call cancel() to abort the task server-side.

Example

const stream = client.delegateStream(task);
for await (const event of stream.events) {
  if (shouldAbort) await stream.cancel('user requested');
}

readonly events: AsyncGenerator<SseEvent>

The async generator yielding SSE events

readonly taskId: string

The task ID being tracked

cancel(reason?): Promise<void>

Cancel the task server-side and close the stream

string

Promise<void>