W3Booster SDK 2.0.0
    Preparing search index...

    Interface W3BoosterEventEmitter<TSettings, TOverlayExtensions>

    interface W3BoosterEventEmitter<
        TSettings extends object = JsonObject,
        TOverlayExtensions extends object = object,
    > {
        off<K extends keyof W3BoosterEventMap<TSettings, TOverlayExtensions>>(
            type: K,
            listener: (
                data: W3BoosterEventMap<TSettings, TOverlayExtensions>[K],
            ) => void,
        ): void;
        off(type: string, listener: (data: unknown) => void): void;
        on<K extends keyof W3BoosterEventMap<TSettings, TOverlayExtensions>>(
            type: K,
            listener: (
                data: W3BoosterEventMap<TSettings, TOverlayExtensions>[K],
            ) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        on(
            type: "*",
            listener: (
                event: W3BoosterEvent<TSettings, TOverlayExtensions>,
            ) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        once<K extends keyof W3BoosterEventMap<TSettings, TOverlayExtensions>>(
            type: K,
            listener: (
                data: W3BoosterEventMap<TSettings, TOverlayExtensions>[K],
            ) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        once(
            type: "*",
            listener: (
                event: W3BoosterEvent<TSettings, TOverlayExtensions>,
            ) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        onceUnknown(
            type: string,
            listener: (data: unknown) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        onUnknown(
            type: string,
            listener: (data: unknown) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
    }

    Type Parameters

    • TSettings extends object = JsonObject
    • TOverlayExtensions extends object = object
    Index
    • Parameters

      • type: string
      • listener: (data: unknown) => void | Promise<void>
      • Optionaloptions: SubscriptionOptions

      Returns () => void

    • Parameters

      • type: string
      • listener: (data: unknown) => void | Promise<void>
      • Optionaloptions: SubscriptionOptions

      Returns () => void