Share via


@azure/core-sse package

Interfaces

EventMessage

Represents a message sent in an event stream https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format

EventMessageStream

A stream of event messages

NodeJSReadableStream

A Node.js Readable stream that also has a destroy method.

Functions

createSseStream(ReadableStream<Uint8Array>)

Processes a response stream into a stream of events.

createSseStream(IncomingMessage)

Processes a response stream into a stream of events.

createSseStream(NodeJSReadableStream)

Processes a response stream into a stream of events.

Function Details

createSseStream(ReadableStream<Uint8Array>)

Processes a response stream into a stream of events.

function createSseStream(chunkStream: ReadableStream<Uint8Array>): EventMessageStream

Parameters

chunkStream

ReadableStream<Uint8Array>

A stream of Uint8Array chunks

Returns

A stream of EventMessage objects

createSseStream(IncomingMessage)

Processes a response stream into a stream of events.

function createSseStream(chunkStream: IncomingMessage): EventMessageStream

Parameters

chunkStream

IncomingMessage

A NodeJS HTTP response

Returns

A stream of EventMessage objects

createSseStream(NodeJSReadableStream)

Processes a response stream into a stream of events.

function createSseStream(chunkStream: NodeJSReadableStream): EventMessageStream

Parameters

chunkStream
NodeJSReadableStream

A NodeJS Readable stream

Returns

A stream of EventMessage objects