Class Stream<A>

constructor

• new Stream<A = unknown>(
      start: (stream: Stream<A>) => Promise<A>,
      signal?: AbortSignal,
      passive?: boolean,
  ): Stream<A>

  Type Parameters

  • A = unknown

  Parameters

  • start: (stream: Stream<A>) => Promise<A>
  • Optionalsignal: AbortSignal
  • passive: boolean = false

  Returns Stream<A>

Readonlypassive

Readonlyresult

Readonlywriter

callId

• get callId(): string | null

  The id of the call the stream was opened on (null until it starts).

  Returns string | null

signal

• get signal(): AbortSignal

  Aborted when the stream is closed.

  Returns AbortSignal

text

• get text(): string

  The answer so far: its text since the call's latest request (streaming.md, law 3). Provisional: result has the typed value.

  Returns string

tree

• get tree(): string | null

  The log's id (its outermost call's), once the call started.

  Returns string | null

waiting

• get waiting(): Approval[]

  The tool calls this stream's call waits for a person to approve (approve rules, a plugin's ask).

  Returns Approval[]

[asyncIterator]

• "[asyncIterator]"(): AsyncGenerator<string>

  The answer's text, piece by piece (a retry's discarded text included: result is the truth).

  Returns AsyncGenerator<string>

approve

• approve(
      approval?: number | Approval | null,
      opts?: { by?: string | null },
  ): void

  Say yes to a tool call the call waits for (s.waiting[0], its invocation number, or nothing for the only one): the tool runs and the call goes on.

  Parameters

  • Optionalapproval: number | Approval | null
  • opts: { by?: string | null } = {}

  Returns void

close

• close(): void

  Stop the call: no new request starts, and it ends with Cancelled.

  Returns void

deny

• deny(
      approval?: number | Approval | null,
      reason?: string | null,
      opts?: { by?: string | null },
  ): void

  Say no: the model is told the person did not allow it (and why), and may try something else.

  Parameters

  • Optionalapproval: number | Approval | null
  • Optionalreason: string | null
  • opts: { by?: string | null } = {}

  Returns void

events

• events(opts?: EventsOptions): AsyncGenerator<StreamEvent>

  Every event, in order, as it happens: the call's and those of the calls inside it (a stream opened inside a tree shows the tree's numbers, its first after null). form: "kept" gives what the log may keep; view a view made from the form; after resumes after an event of that form (EventUnknown when the form has none).

  Parameters

  • opts: EventsOptions = {}

  Returns AsyncGenerator<StreamEvent>

read

• read(
      tree: string | null,
      after: Position | null,
      opts?: Omit<EventsOptions, "after">,
  ): ReadAnswer

  The events of a form after one this reader has (streaming.md, "Resuming"): this process gives any form of its log while it runs. event-unknown when that form has no such event.

  Parameters

  • tree: string | null
  • after: Position | null
  • opts: Omit<EventsOptions, "after"> = {}

  Returns ReadAnswer

then

• then<T1 = A, T2 = never>(
      ok?: ((value: A) => T1 | PromiseLike<T1>) | null,
      fail?: ((reason: unknown) => T2 | PromiseLike<T2>) | null,
  ): Promise<T1 | T2>

  Attaches callbacks for the resolution and/or rejection of the Promise.

  Type Parameters

  • T1 = A
  • T2 = never

  Parameters

  • Optionalok: ((value: A) => T1 | PromiseLike<T1>) | null
  • Optionalfail: ((reason: unknown) => T2 | PromiseLike<T2>) | null

  Returns Promise<T1 | T2>

  A Promise for the completion of which ever callback is executed.