Interface SSESubscribeHandlers<TDoc, TStart>

Callback handlers for an SSE subscription.

interface SSESubscribeHandlers<TDoc = any, TStart = any> {
    onStart?: (info: TStart) => void;
    onUpdate: (doc: TDoc) => void;
    onError?: (err: Error | Event) => void;
    onClose?: () => void;
}

Type Parameters

  • TDoc = any
  • TStart = any

Properties

onStart? onUpdate onError? onClose?

Properties

OptionalonStart

onStart?: (info: TStart) => void

Fired once on connect with the relay's startInfo payload.

onUpdate

onUpdate: (doc: TDoc) => void

Fired for every change-stream update.

OptionalonError

onError?: (err: Error | Event) => void

Fired on connection error. The connection will not be auto-reopened.

OptionalonClose

onClose?: () => void

Fired when the connection is closed (either by client or server).

Settings

Member Visibility

On This Page

Properties