Share via

EventStream interface

  • Reference
Package:
@azure/openai

A readable stream that is iterable and disposable.

Extends

ReadableStream<T>,AsyncIterable<T>

Inherited Properties

locked

Inherited Methods

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

Inherited Property Details

locked 

locked: boolean

Property Value

boolean

Inherited From ReadableStream.locked

Inherited Method Details

cancel(any) 

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

Parameters

reason

any

Returns

Promise<void>

Inherited From ReadableStream.cancel

getReader() 

function getReader(): ReadableStreamDefaultReader<T>

Returns

ReadableStreamDefaultReader<T>

Inherited From ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions) 

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

Parameters

options

ReadableStreamGetReaderOptions

Returns

ReadableStreamReader<T>

Inherited From ReadableStream.getReader

getReader({ mode: "byob" }) 

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

Parameters

options

{ mode: "byob" }

Returns

ReadableStreamBYOBReader

Inherited From ReadableStream.getReader

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

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

Parameters

transform

ReadableWritablePair<T, T>

options

StreamPipeOptions

Returns

ReadableStream<T>

Inherited From ReadableStream.pipeThrough

pipeTo(WritableStream<T>, StreamPipeOptions) 

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

Parameters

destination

WritableStream<T>

options

StreamPipeOptions

Returns

Promise<void>

Inherited From ReadableStream.pipeTo

tee() 

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

Returns

[ReadableStream<T>, ReadableStream<T>]

Inherited From ReadableStream.tee

[asyncIterator]() 

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

Returns

AsyncIterator<T, any, undefined>

Inherited From AsyncIterable.__@asyncIterator@367