EventStream interface

Paquet:

@azure/openai

Flux lisible qui est itérable et jetable.

Extends

ReadableStream<T>,AsyncIterable<T>

Propriétés héritées

locked

Méthodes héritées

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

Détails de la propriété héritée

locked

locked: boolean

Valeur de propriété

boolean

Hérité de ReadableStream.locked

Détails de la méthode héritée

cancel(any)

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

Paramètres

reason

any

Retours

Promise<void>

Hérité de ReadableStream.cancel

getReader()

function getReader(): ReadableStreamDefaultReader<T>

Retours

ReadableStreamDefaultReader<T>

Hérité de ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions)

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

Paramètres

options

ReadableStreamGetReaderOptions

Retours

ReadableStreamReader<T>

Hérité de ReadableStream.getReader

getReader({ mode: "byob" })

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

Paramètres

options

{ mode: "byob" }

Retours

ReadableStreamBYOBReader

Hérité de ReadableStream.getReader

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

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

Paramètres

transform

ReadableWritablePair<T, T>

options

StreamPipeOptions

Retours

ReadableStream<T>

Hérité de ReadableStream.pipeThrough

pipeTo(WritableStream<T>, StreamPipeOptions)

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

Paramètres

destination

WritableStream<T>

options

StreamPipeOptions

Retours

Promise<void>

Hérité de ReadableStream.pipeTo

tee()

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

Retours

[ReadableStream<T>, ReadableStream<T>]

Hérité de ReadableStream.tee

[asyncIterator]()

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

Retours

AsyncIterator<T, any, undefined>

Hérité de AsyncIterable.__@asyncIterator@367