Interface EventFunctions<TEventData>

interface EventFunctions<TEventData extends EventData> {
    eventData: TEventData;
    clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
    emit<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEventData[TEventName],
    ): Promise<void>;
    emitSerial<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEventData[TEventName],
    ): Promise<void>;
    listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
    off<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<TEventData[TEventName]>,
    ): void;
    offAny(listener: Promise<void> | EventAnyListener<EventArgs>): void;
    on<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<TEventData[TEventName]>,
    ): EventUnsubscribeFunction;
    onAny(listener: EventAnyListener): EventUnsubscribeFunction;
    once<TEventName extends string | number | symbol>(
        eventName: TEventName,
        listener: EventListener<TEventData[TEventName]>,
    ): EventUnsubscribeFunction;
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

eventData

Methods

clearListeners emit emitSerial listenerCount off offAny on onAny once

Properties

eventData

eventData: TEventData

Methods

clearListeners

  • clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void

    Parameters

    Returns void

emit

  • emit<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEventData[TEventName],
    ): Promise<void>

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    Returns Promise<void>

emitSerial

  • emitSerial<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEventData[TEventName],
    ): Promise<void>

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    Returns Promise<void>

listenerCount

  • listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number

    Parameters

    Returns number

off

offAny

on

onAny

once

Settings

Member Visibility

On This Page

Properties
Methods