Options
All
  • Public
  • Public/Protected
  • All
Menu

Options to be used with method emit.

Hierarchy

  • IEmitOptions

Index

Properties

Optional onError

onError: (err: any, name?: string) => void

Callback for catching all unhandled errors from subscribers, from both synchronous and asynchronous subscription functions.

(err: any, name?: string) => void;
param

err: The error that was thrown or rejected.

param

name: The subscription name, if set during subscribe call.

Type declaration

    • (err: any, name?: string): void
    • Parameters

      • err: any
      • Optional name: string

      Returns void

Optional onFinished

onFinished: (count: number) => void

Notification callback of when the last recipient has received the data. Note that asynchronous subscribers may still be processing the data at this point.

(count: number) => void;
param

count: Total number of subscribers that have received the data.

Type declaration

    • (count: number): void
    • Parameters

      • count: number

      Returns void

Optional schedule

schedule: EmitSchedule

Event-emitting schedule. Default is sync.

Legend

  • Property
  • Method
  • Property
  • Inherited method

Generated using TypeDoc