EventMessageStream interface

パッケージ:: @azure/core-sse

イベントメッセージのストリーム

Extends: ReadableStream<EventMessage>,AsyncDisposable,AsyncIterable<EventMessage>

継承されたプロパティ

継承されたメソッド

cancel(any)
getReader()
getReader(ReadableStreamGetReaderOptions)
getReader({ mode: "byob" })
pipeThrough<T>(ReadableWritablePair<T, EventMessage>, StreamPipeOptions)
pipeTo(WritableStream<EventMessage>, 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<EventMessage>

戻り値

ReadableStreamDefaultReader<EventMessage>

readableStream.getReader から継承

getReader(ReadableStreamGetReaderOptions)

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

パラメーター

options: ReadableStreamGetReaderOptions

戻り値

ReadableStreamReader<EventMessage>

readableStream.getReader から継承

getReader({ mode: "byob" })

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

パラメーター

options: { mode: "byob" }

戻り値

ReadableStreamBYOBReader

readableStream.getReader から継承

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

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

パラメーター

transform: ReadableWritablePair<T, EventMessage>

options: StreamPipeOptions

戻り値

ReadableStream<T>

readableStream.pipeThrough から継承

pipeTo(WritableStream<EventMessage>, StreamPipeOptions)

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

パラメーター

destination: WritableStream<EventMessage>

options: StreamPipeOptions

戻り値

Promise<void>

から継承 ReadableStream.pipeTo

tee()

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

戻り値

[ReadableStream<EventMessage>, ReadableStream<EventMessage>]

ReadableStream.tee から継承された

[asyncIterator]()

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

戻り値

AsyncIterator<EventMessage, any, undefined>

継承者 AsyncIterable.__@asyncIterator@47