Interface: SubEventInterface<SenderType, DataType>
An event which can be emitted with optional data to subscribers.
Type parameters
| Name |
|---|
SenderType |
DataType |
Implemented by
Methods
clear
▸ clear(): void
Clears all subscriptions to this event.
Returns
void
Defined in
src/sdk/sub/SubEvent.ts:32
notify
▸ notify(sender, data): void
Emits an event to subscribers.
Parameters
| Name | Type | Description |
|---|---|---|
sender | SenderType | The source of the event. |
data | DataType | Data associated with the event. |
Returns
void
Defined in
src/sdk/sub/SubEvent.ts:39
off
▸ off(handler): void
Unsubscribes a callback function from this event.
Parameters
| Name | Type | Description |
|---|---|---|
handler | (sender: SenderType, data: DataType) => 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.
Defined in
src/sdk/sub/SubEvent.ts:27
on
▸ on(handler, paused?): Subscription
Subscribes to this event.
Parameters
| Name | Type | Description |
|---|---|---|
handler | (sender: SenderType, data: DataType) => void | A function to be called when an event is emitted. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false. |
Returns
The new subscription.
Defined in
src/sdk/sub/SubEvent.ts:19