Class SseStream<Item>

Stream implemented as an async iterable.

Type Parameters

Item

Hierarchy (View Summary)

SseStream
- AzureOpenAiChatCompletionStream
- OrchestrationStream

Implements

AsyncIterable<Item>

Index

Constructors

Properties

controller iterator

Methods

[asyncIterator] toReadableStream transformToSseStream

Constructors

constructor

new SseStream<Item>(
iterator: () => AsyncIterator<Item>,
controller: AbortController,
): SseStream<Item>
Type Parameters
- Item
Parameters
- iterator: () => AsyncIterator<Item>
- controller: AbortController
Returns SseStream<Item>
- Defined in packages/core/dist/stream/sse-stream.d.ts:10

Properties

controller

controller: AbortController

iterator

iterator: () => AsyncIterator<Item>

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Item>
Returns AsyncIterator<Item>
Implementation of AsyncIterable.[asyncIterator]
- Defined in packages/core/dist/stream/sse-stream.d.ts:11

toReadableStream

toReadableStream(): ReadableStream<Uint8Array<ArrayBufferLike>>
Converts this stream to a newline-delimited JSON ReadableStream.

Returns ReadableStream<Uint8Array<ArrayBufferLike>>
A ReadableStream of UTF-8 encoded NDJSON bytes.
- Defined in packages/core/dist/stream/sse-stream.d.ts:16

`Protected` `Static`transformToSseStream

transformToSseStream<Item>(
response: HttpResponse,
controller: AbortController,
): SseStream<Item>
Type Parameters
- Item
Parameters
- response: HttpResponse
- controller: AbortController
Returns SseStream<Item>
- Defined in packages/core/dist/stream/sse-stream.d.ts:8