Class: SubEvent<SenderType, DataType>

Defined in: src/sdk/sub/SubEvent.ts:45

An implementation of SubEventInterface.

Type Parameters

Type Parameter
SenderType
DataType

Implements

• SubEventInterface<SenderType, DataType>

Constructors

Constructor

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

Returns

SubEvent<SenderType, DataType>

Methods

clear()

clear(): void

Defined in: src/sdk/sub/SubEvent.ts:70

Clears all subscriptions to this event.

Returns

void

Implementation of

SubEventInterface.clear

---

notify()

notify(sender, data): void

Defined in: src/sdk/sub/SubEvent.ts:83

Emits an event to subscribers.

Parameters

Parameter	Type	Description
sender	SenderType	The source of the event.
data	DataType	Data associated with the event.

Returns

void

Implementation of

SubEventInterface.notify

---

off()

off(handler): void

Defined in: src/sdk/sub/SubEvent.ts:64

Unsubscribes a callback function from this event.

Parameters

Parameter	Type	Description
handler	(sender, data) => void	The 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

---

on()

on(handler, paused): Subscription

Defined in: src/sdk/sub/SubEvent.ts:52

Subscribes to this event.

Parameters

Parameter	Type	Default value	Description
handler	(sender, data) => void	undefined	A function to be called when an event is emitted.
paused	boolean	false	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

SubEventInterface.on