Skip to main content

Class: SubEvent<SenderType, DataType>

An implementation of SubEventInterface.

Type parameters

Name
SenderType
DataType

Implements

Constructors

constructor

new SubEvent<SenderType, DataType>(): SubEvent<SenderType, DataType>

Type parameters

Name
SenderType
DataType

Returns

SubEvent<SenderType, DataType>

Methods

clear

clear(): void

Clears all subscriptions to this event.

Returns

void

Implementation of

SubEventInterface.clear

Defined in

src/sdk/sub/SubEvent.ts:70


notify

notify(sender, data): void

Emits an event to subscribers.

Parameters

NameTypeDescription
senderSenderTypeThe source of the event.
dataDataTypeData associated with the event.

Returns

void

Implementation of

SubEventInterface.notify

Defined in

src/sdk/sub/SubEvent.ts:83


off

off(handler): void

Unsubscribes a callback function from this event.

Parameters

NameTypeDescription
handler(sender: SenderType, data: DataType) => voidThe function to unsubscribe.

Returns

void

Deprecated

This method has been deprecated in favor of using the Subscription object returned by .on() to manage subscriptions.

Implementation of

SubEventInterface.off

Defined in

src/sdk/sub/SubEvent.ts:64


on

on(handler, paused?): Subscription

Subscribes to this event.

Parameters

NameTypeDefault valueDescription
handler(sender: SenderType, data: DataType) => voidundefinedA function to be called when an event is emitted.
pausedbooleanfalseWhether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

SubEventInterface.on

Defined in

src/sdk/sub/SubEvent.ts:52