Compartir a través de

EventStream interface

  • Referencia
Paquete:
@azure/openai

Secuencia legible que es iterable y descartable.

Extends

ReadableStream<T>,AsyncIterable<T>

Propiedades heredadas

locked

Métodos heredados

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

Detalles de las propiedades heredadas

locked 

locked: boolean

Valor de propiedad

boolean

Heredado de ReadableStream.locked

Detalles de los métodos heredados

cancel(any) 

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

Parámetros

reason

any

Devoluciones

Promise<void>

Heredado de ReadableStream.cancel

getReader() 

function getReader(): ReadableStreamDefaultReader<T>

Devoluciones

ReadableStreamDefaultReader<T>

Heredado de ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions) 

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

Parámetros

options

ReadableStreamGetReaderOptions

Devoluciones

ReadableStreamReader<T>

Heredado de ReadableStream.getReader

getReader({ mode: "byob" }) 

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

Parámetros

options

{ mode: "byob" }

Devoluciones

ReadableStreamBYOBReader

Heredado de ReadableStream.getReader

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

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

Parámetros

transform

ReadableWritablePair<T, T>

options

StreamPipeOptions

Devoluciones

ReadableStream<T>

Heredado de ReadableStream.pipeThrough

pipeTo(WritableStream<T>, StreamPipeOptions) 

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

Parámetros

destination

WritableStream<T>

options

StreamPipeOptions

Devoluciones

Promise<void>

Heredado de ReadableStream.pipeTo

tee() 

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

Devoluciones

[ReadableStream<T>, ReadableStream<T>]

Heredado de ReadableStream.tee

[asyncIterator]() 

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

Devoluciones

AsyncIterator<T, any, undefined>

Heredado de AsyncIterable.__@asyncIterator@367