@mappedin/mappedin-js 5.27.0 → 5.28.0

package/lib/esm/get-venue/index.d.ts

@@ -178,7 +178,7 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue' {
             url: string;
             updated_at: string;
     }>;
-    export function downloadMakerMVF(userOptions: TGetVenueMakerOptions): Promise<Uint8Array>;
+    export function downloadMVF(userOptions: TGetVenueMakerOptions): Promise<Uint8Array>;
     /**
         * Returns a {@link Mappedin} object hydrated with JSON data.
         * @param {string|Object} mappedinSerializableData A JSON string or object representing a venue.
@@ -1639,21 +1639,60 @@ declare module '@mappedin/mappedin-js/lib/esm/get-venue/Mappedin.MVF.types' {
 }
 
 declare module '@mappedin/mappedin-js/lib/esm/get-venue/pub-sub.typed' {
+    /**
+        * Generic PubSub class implementing the Publish-Subscribe pattern for event handling.
+        *
+        * @template EVENT_PAYLOAD - The type of the event payload.
+        * @template EVENT - The type of the event.
+        */
     export class PubSub<EVENT_PAYLOAD, EVENT extends keyof EVENT_PAYLOAD> {
             /**
                 * @private
+                * @internal
                 */
             _subscribers: any;
             /**
                 * @private
+                * @internal
                 */
             publish<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, data?: EVENT_PAYLOAD[EVENT_NAME]): void;
+            /**
+                * Subscribe a function to an event.
+                *
+                * @param eventName An event name which, when fired, will call the provided
+                * function.
+                * @param fn A callback that gets called when the corresponding event is fired. The
+                * callback will get passed an argument with a type that's one of event payloads.
+                * @example
+                * // Subscribe to the 'click' event
+                * const handler = (event) => {
+                *  const { coordinate } = event;
+                *  const { latitude, longitude } = coordinate;
+                * 	console.log(`Map was clicked at ${latitude}, ${longitude}`);
+                * };
+                * map.on('click', handler);
+                */
             on<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME] extends {
                     data: null;
             } ? EVENT_PAYLOAD[EVENT_NAME]['data'] : EVENT_PAYLOAD[EVENT_NAME]) => void): void;
+            /**
+                * Unsubscribe a function previously subscribed with {@link on}
+                *
+                * @param eventName An event name to which the provided function was previously
+                * subscribed.
+                * @param fn A function that was previously passed to {@link on}. The function must
+                * have the same reference as the function that was subscribed.
+                * @example
+                * // Unsubscribe from the 'click' event
+                * const handler = (event) => {
+                * 	console.log('Map was clicked', event);
+                * };
+                * map.off('click', handler);
+                */
             off<EVENT_NAME extends EVENT>(eventName: EVENT_NAME, fn: (payload: EVENT_PAYLOAD[EVENT_NAME]) => void): void;
             /**
                 * @private
+                * @internal
                 */
             destroy(): void;
     }