EventMessageStream interface

Package:: @azure/core-sse

A stream of event messages

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

Inherited Properties

Inherited Methods

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

Returns

ReadableStreamDefaultReader<EventMessage>

Inherited From ReadableStream.getReader

getReader(ReadableStreamGetReaderOptions)

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

Parameters

options: ReadableStreamGetReaderOptions

Returns

ReadableStreamReader<EventMessage>

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, EventMessage>, StreamPipeOptions)

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

Parameters

transform: ReadableWritablePair<T, EventMessage>

options: StreamPipeOptions

Returns

ReadableStream<T>

Inherited From ReadableStream.pipeThrough

pipeTo(WritableStream<EventMessage>, StreamPipeOptions)

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

Parameters

destination: WritableStream<EventMessage>

options: StreamPipeOptions

Returns

Promise<void>

Inherited From ReadableStream.pipeTo

tee()

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

Returns

[ReadableStream<EventMessage>, ReadableStream<EventMessage>]

Inherited From ReadableStream.tee

[asyncIterator]()

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

Returns

AsyncIterator<EventMessage, any, undefined>

Inherited From AsyncIterable.__@asyncIterator@47