Variable EventsConst

Type Declaration

• on: function

  • on<K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)>(
        event: K,
        handler: GeoLeafEventHandler<K>,
    ): void

    Registers a listener for a GeoLeaf event. The listener is called every time the event fires until off() is called.

    Type Parameters

    • K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)

    Parameters

    • event: K

      Event name (see module docs for full reference).

    • handler: GeoLeafEventHandler<K>

      Callback receiving the CustomEvent with typed detail.

    Returns void

    Example

    GeoLeaf.Events.on("geoleaf:poi:click", (e) => {
        console.log("POI cliqué :", e.detail.poiId);
    });
    Copy

• off: function

  • off<K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)>(
        event: K,
        handler: GeoLeafEventHandler<K>,
    ): void

    Removes a previously registered listener. The exact same handler reference must be passed.

    Type Parameters

    • K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)

    Parameters

    • event: K

      Event name.

    • handler: GeoLeafEventHandler<K>

      The handler reference originally passed to on().

    Returns void

    Example

    // Le handler doit être NOMMÉ : une fonction anonyme ne peut jamais être retirée.
    const handlePoiClick = (e) => {
        console.log(e.detail.poiId);
    };
    GeoLeaf.Events.on("geoleaf:poi:click", handlePoiClick);
    
    // Plus tard :
    GeoLeaf.Events.off("geoleaf:poi:click", handlePoiClick);
    Copy

• once: function

  • once<K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)>(
        event: K,
        handler: GeoLeafEventHandler<K>,
    ): void

    Registers a listener that fires once then automatically removes itself. Uses the native {once: true} option — no wrapper function needed.

    Type Parameters

    • K extends (keyof GeoLeafEventMap) | (keyof GeoLeafRawEventMap)

    Parameters

    • event: K

      Event name.

    • handler: GeoLeafEventHandler<K>

      Callback called at most once.

    Returns void

    Example

    GeoLeaf.Events.once("geoleaf:app:ready", () => {
        console.log("App prête !");
    });
    Copy