chore: add missing jsdocs #38

Author: wazolab

index.html

@@ -90,6 +90,33 @@
       document.getElementById('select-feature').addEventListener('click', selectFeature)
     })
 
+    // Custom rendering functions
+    const markerRender = (element, markerSize, feature) => {
+      element.textContent = feature.properties.mag
+
+      buildCss(element, {
+        'background-color': 'green',
+        'border-radius': '100%',
+        'justify-content': 'center',
+        'align-items': 'center',
+        'display': 'flex',
+        'color': 'white',
+        'width': `${markerSize}px`,
+        'height': `${markerSize}px`,
+        'cursor': 'pointer'
+      });
+    }
+
+    const pinMarkerRender = (coords, offset) => {
+      return new maplibregl.Marker({
+        scale: 1.3,
+        color: '#f44336',
+        anchor: 'bottom'
+      })
+        .setLngLat(coords)
+        .setOffset(offset)
+    }
+
     const clusterRender = (element, props) => {
       element.innerHTML = props.point_count.toLocaleString();
 
@@ -107,6 +134,7 @@
       });
     }
 
+    // Specific features showcase functions
     const loadData = async () => {
       const url = document.getElementById('custom-url').value
 
@@ -131,32 +159,6 @@
       })
     }
 
-    const markerRender = (element, markerSize, feature) => {
-      element.textContent = feature.properties.mag
-
-      buildCss(element, {
-        'background-color': 'green',
-        'border-radius': '100%',
-        'justify-content': 'center',
-        'align-items': 'center',
-        'display': 'flex',
-        'color': 'white',
-        'width': `${markerSize}px`,
-        'height': `${markerSize}px`,
-        'cursor': 'pointer'
-      });
-    }
-
-    const pinMarkerRender = (coords, offset) => {
-      return new maplibregl.Marker({
-        scale: 1.3,
-        color: '#f44336',
-        anchor: 'bottom'
-      })
-        .setLngLat(coords)
-        .setOffset(offset)
-    }
-
     const selectFeature = async () => {
       const id = document.getElementById('feature-id').value
 

src/teritorio-cluster.ts

@@ -34,7 +34,7 @@ export class TeritorioCluster extends EventTarget implements CustomLayerInterfac
     pinMarkerRender: pinMarkerRenderDefault,
   } satisfies TeritorioClusterOptions
 
-  // Internal map and layer configuration
+  // Internal layer configuration
   private map: MapGL | null = null
   private readonly sourceId: string
   private source: GeoJSONSource | null = null
@@ -51,7 +51,7 @@ export class TeritorioCluster extends EventTarget implements CustomLayerInterfac
   private abortExec: number = 0
 
   /**
-   * Constructs a new TeritorioCluster.
+   * Creates a new instance of the TeritorioCluster custom layer.
    * @param id - Unique ID for the layer.
    * @param sourceId - ID of the GeoJSON source.
    * @param options - Optional configuration overrides.
@@ -69,9 +69,9 @@ export class TeritorioCluster extends EventTarget implements CustomLayerInterfac
   }
 
   /**
-   * Called when the layer is added to the map.
+   * Initializes the cluster layer when added to the map.
    *
-   * @param map - The map instance to which the layer is being added.
+   * @param map - The MapLibre GL map instance.
    *
    * @remarks
    * This method is called when the layer is first added to the map. It performs the following actions:
@@ -193,6 +193,12 @@ export class TeritorioCluster extends EventTarget implements CustomLayerInterfac
     }
   }
 
+  /**
+   * Updates the fit bounds configuration used for clustering.
+   *
+   * @param options - The options to apply when fitting the bounds,
+   * such as padding, maximum zoom level, and animation settings.
+   */
   public setBoundsOptions = (options: FitBoundsOptions): void => {
     this.opts.fitBoundsOptions = options
   }