Поделиться через

EventStream interface

  • Ссылка
Пакет:
@azure/openai

Доступный для чтения поток, который является итерируемым и одноразовым.

Extends

ReadableStream<T>,AsyncIterable<T>

Унаследованные свойства

locked

Наследуемые методы

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

Сведения об унаследованном свойстве

locked 

locked: boolean

Значение свойства

boolean

наследуется от ReadableStream.locked

Сведения о наследуемом методе

cancel(any) 

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

Параметры

reason

any

Возвращаемое значение

Promise<void>

унаследовано от ReadableStream.cancel

getReader() 

function getReader(): ReadableStreamDefaultReader<T>

Возвращаемое значение

ReadableStreamDefaultReader<T>

унаследован от ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions) 

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

Параметры

options

ReadableStreamGetReaderOptions

Возвращаемое значение

ReadableStreamReader<T>

унаследован от ReadableStream.getReader

getReader({ mode: "byob" }) 

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

Параметры

options

{ mode: "byob" }

Возвращаемое значение

ReadableStreamBYOBReader

унаследован от ReadableStream.getReader

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

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

Параметры

transform

ReadableWritablePair<T, T>

options

StreamPipeOptions

Возвращаемое значение

ReadableStream<T>

унаследовано от ReadableStream.pipeThrough

pipeTo(WritableStream<T>, StreamPipeOptions) 

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

Параметры

destination

WritableStream<T>

options

StreamPipeOptions

Возвращаемое значение

Promise<void>

Унаследовано от ReadableStream.pipeTo

tee() 

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

Возвращаемое значение

[ReadableStream<T>, ReadableStream<T>]

унаследовано от ReadableStream.tee

[asyncIterator]() 

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

Возвращаемое значение

AsyncIterator<T, any, undefined>

наследуется от AsyncIterable.__@asyncIterator@374