Class Callbacks<Types, Ctx>

Typed event registry with support for one-time listeners, protected listeners, and delayed execution.

Used internally by Module and all components, but can also be instantiated on its own.

Type Parameters

Hierarchy

  • Destroyable
    • Callbacks

Constructors

constructor

Accessors

isDestroyed list

Methods

_destroy add destroy emit on onDestroy remove

Constructors

constructor

Accessors

isDestroyed

  • get isDestroyed(): boolean

    Indicates whether the instance has been destroyed.

    After destruction, destroy is a no-op.

    Returns boolean

list

  • get list(): ICallback<Types, Ctx>[]

    Snapshot of all registered callbacks.

    Useful for debugging; do not mutate the returned array.

    Returns ICallback<Types, Ctx>[]

Methods

Protected_destroy

  • _destroy(): void

    Clears all registered callbacks.

    Returns void

add

  • add<T extends string | number | symbol>(
        target: T,
        action: TCallbacksAction<Types[T], Ctx>,
        settings?: ICallbacksSettings,
    ): { id: string; remove: () => boolean }

    Registers a callback and returns its id plus a removal function.

    Prefer on when you only need the destructor.

    Type Parameters

    • T extends string | number | symbol

    Parameters

    Returns { id: string; remove: () => boolean }

destroy

  • destroy(): void

    Destroys the instance and runs all registered cleanup actions.

    Safe to call multiple times; subsequent calls are ignored.

    Execution order:

    1. _destroy
    2. all onDestroy callbacks, in registration order
    3. isDestroyed is set to true

    Returns void

emit

  • emit<T extends string | number | symbol>(target: T, arg: Types[T]): void

    Invokes all listeners registered for the given event.

    Type Parameters

    • T extends string | number | symbol

    Parameters

    • target: T

      Event name.

    • arg: Types[T]

      Payload passed as the first argument to each listener.

    Returns void

on

onDestroy

  • onDestroy(action: () => void): void

    Registers a function to run when the instance is destroyed.

    If the instance is already destroyed, action runs immediately.

    Parameters

    • action: () => void

      Cleanup function (for example remove listeners or DOM classes).

    Returns void

remove

  • remove(id: string): boolean

    Removes a callback by id.

    Protected callbacks are skipped unless they are cleared internally (for example on destroy).

    Parameters

    • id: string

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods