Freigeben über

EventStream interface

  • Referenz
Paket:
@azure/openai

Ein lesbarer Stream, der iterierbar und verwerfbar ist.

Extends

ReadableStream<T>,AsyncIterable<T>

Geerbte Eigenschaften

locked

Geerbte Methoden

cancel(any)
getReader()
getReader(ReadableStreamGetReaderOptions)
getReader({ mode: "byob" })
pipeThrough<T>(ReadableWritablePair<T, T>, StreamPipeOptions)
pipeTo(WritableStream<T>, StreamPipeOptions)
tee()
[asyncIterator]()

Geerbte Eigenschaftsdetails

locked 

locked: boolean

Eigenschaftswert

boolean

Geerbt von ReadableStream.locked

Details zur geerbten Methode

cancel(any) 

function cancel(reason?: any): Promise<void>

Parameter

reason

any

Gibt zurück

Promise<void>

Geerbt von ReadableStream.cancel

getReader() 

function getReader(): ReadableStreamDefaultReader<T>

Gibt zurück

ReadableStreamDefaultReader<T>

Geerbt von ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions) 

function getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<T>

Parameter

options

ReadableStreamGetReaderOptions

Gibt zurück

ReadableStreamReader<T>

Geerbt von ReadableStream.getReader

getReader({ mode: "byob" }) 

function getReader(options: { mode: "byob" }): ReadableStreamBYOBReader

Parameter

options

{ mode: "byob" }

Gibt zurück

ReadableStreamBYOBReader

Geerbt von ReadableStream.getReader

pipeThrough<T>(ReadableWritablePair<T, T>, StreamPipeOptions) 

function pipeThrough<T>(transform: ReadableWritablePair<T, T>, options?: StreamPipeOptions): ReadableStream<T>

Parameter

transform

ReadableWritablePair<T, T>

options

StreamPipeOptions

Gibt zurück

ReadableStream<T>

Geerbt von ReadableStream.pipeThrough

pipeTo(WritableStream<T>, StreamPipeOptions) 

function pipeTo(destination: WritableStream<T>, options?: StreamPipeOptions): Promise<void>

Parameter

destination

WritableStream<T>

options

StreamPipeOptions

Gibt zurück

Promise<void>

Geerbt von ReadableStream.pipeTo

tee() 

function tee(): [ReadableStream<T>, ReadableStream<T>]

Gibt zurück

[ReadableStream<T>, ReadableStream<T>]

Geerbt von ReadableStream.tee

[asyncIterator]() 

function [asyncIterator](): AsyncIterator<T, any, undefined>

Gibt zurück

AsyncIterator<T, any, undefined>

Geerbt von AsyncIterable.__@asyncIterator@367