Interface RuntimeEventSource<TEvents>

Uniform typed event surface implemented by interactive controllers.

interface RuntimeEventSource<TEvents extends object> {
    off<TKey extends string | number | symbol>(
        type: TKey,
        listener: RuntimeEventListener<TEvents[TKey]>,
    ): void;
    on<TKey extends string | number | symbol>(
        type: TKey,
        listener: RuntimeEventListener<TEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends string | number | symbol>(
        type: TKey,
        listener: RuntimeEventListener<TEvents[TKey]>,
    ): Unsubscribe;
}

Type Parameters

TEvents extends object

Hierarchy (View Summary)

RuntimeEventSource

Index

Methods

Methods

off

off<TKey extends string | number | symbol>(
type: TKey,
listener: RuntimeEventListener<TEvents[TKey]>,
): void
Removes a previously registered listener.
Type Parameters
- TKey extends string | number | symbol
Parameters
- type: TKey
- listener: RuntimeEventListener<TEvents[TKey]>
Returns void
- Defined in core/types.ts:65

on

on<TKey extends string | number | symbol>(
type: TKey,
listener: RuntimeEventListener<TEvents[TKey]>,
): Unsubscribe
Registers a listener and returns an idempotent unsubscribe function.
Type Parameters
- TKey extends string | number | symbol
Parameters
- type: TKey
- listener: RuntimeEventListener<TEvents[TKey]>
Returns Unsubscribe
- Defined in core/types.ts:60

once

once<TKey extends string | number | symbol>(
type: TKey,
listener: RuntimeEventListener<TEvents[TKey]>,
): Unsubscribe
Registers a listener that is automatically removed after its first call.
Type Parameters
- TKey extends string | number | symbol
Parameters
- type: TKey
- listener: RuntimeEventListener<TEvents[TKey]>
Returns Unsubscribe
- Defined in core/types.ts:67