Interface ICallback<Types, Ctx>

A registered callback entry stored in Callbacks.list.

interface ICallback<Types, Ctx> {
    action: TCallbacksAction<Types[keyof Types], Ctx>;
    id: string;
    name?: string;
    once?: boolean;
    protected?: boolean;
    target: keyof Types;
    timeout?: number;
}

Type Parameters

  • Types

    Event map.

  • Ctx

    Context type passed to the listener.

Hierarchy (View Summary)

Properties

action id name? once? protected? target timeout?

Properties

action

action: TCallbacksAction<Types[keyof Types], Ctx>

Listener function executed on Callbacks.emit.

id

id: string

Unique callback identifier.

Optionalname

name?: string

Optional label for debugging.

Optionalonce

once?: boolean

When true, the callback is removed automatically after the first execution.

Default

false

Optionalprotected

protected?: boolean

When true, the callback cannot be removed via Callbacks.remove unless it is cleared internally (for example on Callbacks.destroy).

Default

false

target

target: keyof Types

Event name this listener is bound to.

Optionaltimeout

timeout?: number

Delay before the callback runs, in milliseconds.

Default

undefined

Settings

Member Visibility

On This Page

Properties