33 lines
1.4 KiB
TypeScript
33 lines
1.4 KiB
TypeScript
|
import { type ReadableStream } from "../internal/shim-types.js";
|
||
|
|
import type { OpenAI } from "../client.js";
|
||
|
|
export type ServerSentEvent = {
|
||
|
|
event: string | null;
|
||
|
|
data: string;
|
||
|
|
raw: string[];
|
||
|
|
};
|
||
|
|
export declare class Stream<Item> implements AsyncIterable<Item> {
|
||
|
|
#private;
|
||
|
|
private iterator;
|
||
|
|
controller: AbortController;
|
||
|
|
constructor(iterator: () => AsyncIterator<Item>, controller: AbortController, client?: OpenAI);
|
||
|
|
static fromSSEResponse<Item>(response: Response, controller: AbortController, client?: OpenAI): Stream<Item>;
|
||
|
|
/**
|
||
|
|
* Generates a Stream from a newline-separated ReadableStream
|
||
|
|
* where each item is a JSON value.
|
||
|
|
*/
|
||
|
|
static fromReadableStream<Item>(readableStream: ReadableStream, controller: AbortController, client?: OpenAI): Stream<Item>;
|
||
|
|
[Symbol.asyncIterator](): AsyncIterator<Item>;
|
||
|
|
/**
|
||
|
|
* Splits the stream into two streams which can be
|
||
|
|
* independently read from at different speeds.
|
||
|
|
*/
|
||
|
|
tee(): [Stream<Item>, Stream<Item>];
|
||
|
|
/**
|
||
|
|
* Converts this stream to a newline-separated ReadableStream of
|
||
|
|
* JSON stringified values in the stream
|
||
|
|
* which can be turned back into a Stream with `Stream.fromReadableStream()`.
|
||
|
|
*/
|
||
|
|
toReadableStream(): ReadableStream;
|
||
|
|
}
|
||
|
|
export declare function _iterSSEMessages(response: Response, controller: AbortController): AsyncGenerator<ServerSentEvent, void, unknown>;
|
||
|
|
//# sourceMappingURL=streaming.d.ts.map
|