Class Stream<Item>

constructor

• new Stream<Item>(
      iterator: () => AsyncIterator<Item>,
      controller: AbortController,
      requestId?: string,
  ): Stream<Item>

  Creates a new Stream instance.

  Type Parameters

  • Item

  Parameters

  • iterator: () => AsyncIterator<Item>

    A function that returns an AsyncIterator.

  • controller: AbortController

    The AbortController for this stream.

  • OptionalrequestId: string

  Returns Stream<Item>

Readonlycontroller

Optional ReadonlyrequestId

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<Item>

  Implements the AsyncIterable interface, allowing the Stream to be used in a for-await-of loop.

  Returns AsyncIterator<Item>

  An AsyncIterator for the stream items.

tee

• tee(): [Stream<Item>, Stream<Item>]

  Splits the stream into two streams which can be independently read from at different speeds.

  Returns [Stream<Item>, Stream<Item>]

  A tuple containing two new Stream instances.

toReadableStream

• toReadableStream(): ReadableStream

  Converts this stream to a newline-separated ReadableStream of JSON stringified values. The resulting stream can be converted back to a Stream using Stream.fromReadableStream().

  Returns ReadableStream

  A ReadableStream containing newline-separated JSON data.

StaticfromReadableStream

• fromReadableStream<Item>(
      readableStream: ReadableStream,
      controller: AbortController,
  ): Stream<Item>

  Creates a Stream from a newline-separated ReadableStream where each item is a JSON value.

  Type Parameters

  • Item

  Parameters

  • readableStream: ReadableStream

    The ReadableStream containing newline-separated JSON data.

  • controller: AbortController

    The AbortController for this stream.

  Returns Stream<Item>

  A new Stream instance.

  Throws

  If the stream is consumed more than once.

StaticfromSSEResponse

• fromSSEResponse<Item>(
      response: Response,
      controller: AbortController,
  ): Stream<Item>

  Creates a Stream from a server-sent events (SSE) Response.

  Type Parameters

  • Item

  Parameters

  • response: Response

    The Response object containing the SSE data.

  • controller: AbortController

    The AbortController for this stream.

  Returns Stream<Item>

  A new Stream instance.

  Throws

  If the stream is consumed more than once.

  Throws

  If the SSE data contains an error.