Share via

IStreamSubscriber interface

  • Reference
Package:
@microsoft/signalr

Defines the expected type for a receiver of results streamed by the server.

Properties

closed

A boolean that will be set by the IStreamResult when the stream is closed.

Methods

complete()

Called by the framework when the end of the stream is reached. After this method is called, no additional methods on the IStreamSubscriber will be called.
error(any)

Called by the framework when an error has occurred. After this method is called, no additional methods on the IStreamSubscriber will be called.
next(T)

Called by the framework when a new item is available.

Property Details

closed

A boolean that will be set by the IStreamResult when the stream is closed.

TypeScript 
closed?: boolean

Property Value

boolean

Method Details

complete()

Called by the framework when the end of the stream is reached. After this method is called, no additional methods on the IStreamSubscriber will be called.

TypeScript 
function complete()

error(any)

Called by the framework when an error has occurred. After this method is called, no additional methods on the IStreamSubscriber will be called.

TypeScript 
function error(err: any)

Parameters

err

any

next(T)

Called by the framework when a new item is available.

TypeScript 
function next(value: T)

Parameters

value

T