共用方式為

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@367