@xylabs/geo 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/geo**
@@ -23,39 +25,47 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Classes
 
-- [GeoJson](#classes/GeoJson)
-- [LayerBase](#classes/LayerBase)
-- [MercatorBoundingBox](#classes/MercatorBoundingBox)
-- [MercatorLngLat](#classes/MercatorLngLat)
+| Class | Description |
+| ------ | ------ |
+| [GeoJson](#classes/GeoJson) | Provides GeoJSON geometry and MapBox source generation from a quadkey. |
+| [LayerBase](#classes/LayerBase) | Abstract base class for managing MapBox map layers with add/remove lifecycle. |
+| [MercatorBoundingBox](#classes/MercatorBoundingBox) | A Mercator bounding box extending MapBox LngLatBounds. |
+| [MercatorLngLat](#classes/MercatorLngLat) | A Mercator coordinate extending MapBox LngLat. |
 
 ## Type Aliases
 
-- [MercatorTile](#type-aliases/MercatorTile)
-- [MercatorBoundary](#type-aliases/MercatorBoundary)
+| Type Alias | Description |
+| ------ | ------ |
+| [MercatorTile](#type-aliases/MercatorTile) | A Mercator tile represented as [x, y, zoom]. |
+| [MercatorBoundary](#type-aliases/MercatorBoundary) | An ordered array of MercatorLngLat points forming a boundary. |
 
 ## Variables
 
-- [d2r](#variables/d2r)
-- [r2d](#variables/r2d)
+| Variable | Description |
+| ------ | ------ |
+| [d2r](#variables/d2r) | Conversion factor from degrees to radians. |
+| [r2d](#variables/r2d) | Conversion factor from radians to degrees. |
 
 ## Functions
 
-- [boundingBoxToBoundary](#functions/boundingBoxToBoundary)
-- [boundingBoxToCenter](#functions/boundingBoxToCenter)
-- [boundingBoxToPolygon](#functions/boundingBoxToPolygon)
-- [tileFromPoint](#functions/tileFromPoint)
-- [tileFromQuadkey](#functions/tileFromQuadkey)
-- [tileToBoundingBox](#functions/tileToBoundingBox)
-- [tileToChildren](#functions/tileToChildren)
-- [tileToGeoJson](#functions/tileToGeoJson)
-- [tileToParent](#functions/tileToParent)
-- [tileToPoint](#functions/tileToPoint)
-- [tileToQuadkey](#functions/tileToQuadkey)
-- [tileToSiblings](#functions/tileToSiblings)
-- [tilesEqual](#functions/tilesEqual)
-- [tilesFromBoundingBox](#functions/tilesFromBoundingBox)
-- [hasSiblings](#functions/hasSiblings)
-- [tilesHasTile](#functions/tilesHasTile)
+| Function | Description |
+| ------ | ------ |
+| [boundingBoxToBoundary](#functions/boundingBoxToBoundary) | Converts a bounding box to an ordered boundary polygon (closed ring of corner points). |
+| [boundingBoxToCenter](#functions/boundingBoxToCenter) | Computes the center point of a bounding box as [lng, lat], rounded to the specified decimal places. |
+| [boundingBoxToPolygon](#functions/boundingBoxToPolygon) | Converts a bounding box to a GeoJSON Polygon geometry. |
+| [tileFromPoint](#functions/tileFromPoint) | Converts a geographic point to the integer Mercator tile containing it at the given zoom level. |
+| [tileFromQuadkey](#functions/tileFromQuadkey) | Converts a quadkey string to a Mercator tile [x, y, zoom]. |
+| [tileToBoundingBox](#functions/tileToBoundingBox) | Converts a Mercator tile to its geographic bounding box. |
+| [tileToChildren](#functions/tileToChildren) | Returns the four child tiles at one zoom level higher. |
+| [tileToGeoJson](#functions/tileToGeoJson) | Converts a Mercator tile to a GeoJSON Polygon geometry. |
+| [tileToParent](#functions/tileToParent) | Returns the parent tile at one zoom level lower. |
+| [tileToPoint](#functions/tileToPoint) | Returns the center point of a Mercator tile. |
+| [tileToQuadkey](#functions/tileToQuadkey) | Converts a Mercator tile to its quadkey string representation. |
+| [tileToSiblings](#functions/tileToSiblings) | Returns the four sibling tiles (children of the parent tile) for the given tile. |
+| [tilesEqual](#functions/tilesEqual) | Checks whether two Mercator tiles are equal by comparing their x, y, and zoom values. |
+| [tilesFromBoundingBox](#functions/tilesFromBoundingBox) | Returns all Mercator tiles that intersect the given bounding box at the specified zoom level. |
+| [hasSiblings](#functions/hasSiblings) | Checks whether all four siblings of the given tile exist in the tile array. |
+| [tilesHasTile](#functions/tilesHasTile) | Checks whether a specific tile exists in the given tile array. |
 
 ### classes
 
@@ -65,19 +75,21 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+Provides GeoJSON geometry and MapBox source generation from a quadkey.
+
 ## Constructors
 
 ### Constructor
 
 ```ts
-new GeoJson(quadkey): GeoJson;
+new GeoJson(quadkey: string): GeoJson;
 ```
 
 ### Parameters
 
-#### quadkey
-
-`string`
+| Parameter | Type |
+| ------ | ------ |
+| `quadkey` | `string` |
 
 ### Returns
 
@@ -88,55 +100,67 @@ new GeoJson(quadkey): GeoJson;
 ### featureCollection()
 
 ```ts
-static featureCollection(features): FeatureCollection;
+static featureCollection(features: Feature<Geometry, GeoJsonProperties>[]): FeatureCollection;
 ```
 
-### Parameters
+Creates a GeoJSON FeatureCollection from an array of features.
 
-#### features
+### Parameters
 
-`Feature`\<`Geometry`, `GeoJsonProperties`\>[]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `features` | `Feature`\<`Geometry`, `GeoJsonProperties`\>[] | The features to include |
 
 ### Returns
 
 `FeatureCollection`
 
+A GeoJSON FeatureCollection
+
 ***
 
 ### featuresSource()
 
 ```ts
-static featuresSource(data): GeoJSONSourceSpecification;
+static featuresSource(data: FeatureCollection): GeoJSONSourceSpecification;
 ```
 
-### Parameters
+Creates a MapBox GeoJSON source specification from a FeatureCollection.
 
-#### data
+### Parameters
 
-`FeatureCollection`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `FeatureCollection` | The FeatureCollection to use as the source data |
 
 ### Returns
 
 `GeoJSONSourceSpecification`
 
+A MapBox GeoJSON source specification
+
 ***
 
 ### geometryFeature()
 
 ```ts
-static geometryFeature(geometry): Feature;
+static geometryFeature(geometry: Geometry): Feature;
 ```
 
-### Parameters
+Wraps a geometry object in a GeoJSON Feature.
 
-#### geometry
+### Parameters
 
-`Geometry`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `geometry` | `Geometry` | The geometry to wrap |
 
 ### Returns
 
 `Feature`
 
+A GeoJSON Feature containing the geometry
+
 ***
 
 ### center()
@@ -145,6 +169,8 @@ static geometryFeature(geometry): Feature;
 center(): LngLat;
 ```
 
+Computes and caches the center point of the quadkey's bounding box as a MapBox LngLat.
+
 ### Returns
 
 `LngLat`
@@ -157,6 +183,8 @@ center(): LngLat;
 point(): Point;
 ```
 
+Returns a GeoJSON Point geometry at the center of the quadkey's bounding box.
+
 ### Returns
 
 `Point`
@@ -169,6 +197,8 @@ point(): Point;
 pointFeature(): Feature;
 ```
 
+Returns a GeoJSON Feature containing the center point geometry.
+
 ### Returns
 
 `Feature`
@@ -181,6 +211,8 @@ pointFeature(): Feature;
 pointFeatureCollection(): FeatureCollection;
 ```
 
+Returns a GeoJSON FeatureCollection containing the center point feature.
+
 ### Returns
 
 `FeatureCollection`
@@ -193,6 +225,8 @@ pointFeatureCollection(): FeatureCollection;
 pointSource(): GeoJSONSourceSpecification;
 ```
 
+Returns a MapBox GeoJSON source specification for the center point.
+
 ### Returns
 
 `GeoJSONSourceSpecification`
@@ -205,6 +239,8 @@ pointSource(): GeoJSONSourceSpecification;
 polygon(): Polygon;
 ```
 
+Returns a GeoJSON Polygon geometry representing the quadkey's bounding box.
+
 ### Returns
 
 `Polygon`
@@ -217,6 +253,8 @@ polygon(): Polygon;
 polygonFeature(): Feature;
 ```
 
+Returns a GeoJSON Feature containing the polygon geometry.
+
 ### Returns
 
 `Feature`
@@ -229,6 +267,8 @@ polygonFeature(): Feature;
 polygonFeatureCollection(): FeatureCollection;
 ```
 
+Returns a GeoJSON FeatureCollection containing the polygon feature.
+
 ### Returns
 
 `FeatureCollection`
@@ -241,6 +281,8 @@ polygonFeatureCollection(): FeatureCollection;
 polygonSource(): GeoJSONSourceSpecification;
 ```
 
+Returns a MapBox GeoJSON source specification for the polygon.
+
 ### Returns
 
 `GeoJSONSourceSpecification`
@@ -253,6 +295,8 @@ polygonSource(): GeoJSONSourceSpecification;
 zoom(): number;
 ```
 
+Returns the zoom level derived from the quadkey length.
+
 ### Returns
 
 `number`
@@ -263,29 +307,28 @@ zoom(): number;
 
 ***
 
-## Type Parameters
+Abstract base class for managing MapBox map layers with add/remove lifecycle.
 
-### T
+## Type Parameters
 
-`T` *extends* `MapBox.Layer`
+| Type Parameter |
+| ------ |
+| `T` *extends* `MapBox.Layer` |
 
 ## Constructors
 
 ### Constructor
 
 ```ts
-new LayerBase<T>(id, source): LayerBase<T>;
+new LayerBase<T>(id: string, source: string): LayerBase<T>;
 ```
 
 ### Parameters
 
-#### id
-
-`string`
-
-#### source
-
-`string`
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+| `source` | `string` |
 
 ### Returns
 
@@ -293,37 +336,27 @@ new LayerBase<T>(id, source): LayerBase<T>;
 
 ## Properties
 
-### id
-
-```ts
-id: string;
-```
-
-***
-
-### source
-
-```ts
-source: string;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="id"></a> `id` | `string` |
+| <a id="source"></a> `source` | `string` |
 
 ## Methods
 
 ### update()
 
 ```ts
-update(map, show?): void;
+update(map: Map$1, show?: boolean): void;
 ```
 
-### Parameters
-
-#### map
+Removes and re-adds the layer on the map, optionally hiding it.
 
-`Map$1`
-
-#### show?
+### Parameters
 
-`boolean` = `true`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `map` | `Map$1` | `undefined` | The MapBox map instance |
+| `show` | `boolean` | `true` | Whether to show the layer after updating (default true) |
 
 ### Returns
 
@@ -337,6 +370,8 @@ update(map, show?): void;
 abstract buildLayer(): T;
 ```
 
+Builds the MapBox layer configuration object.
+
 ### Returns
 
 `T`
@@ -347,6 +382,8 @@ abstract buildLayer(): T;
 
 ***
 
+A Mercator bounding box extending MapBox LngLatBounds.
+
 ## Extends
 
 - `LngLatBounds`
@@ -356,18 +393,18 @@ abstract buildLayer(): T;
 ### Constructor
 
 ```ts
-new MercatorBoundingBox(sw?, ne?): MercatorBoundingBox;
+new MercatorBoundingBox(sw?: 
+  | [number, number, number, number]
+  | LngLatLike
+  | [LngLatLike, LngLatLike], ne?: LngLatLike): MercatorBoundingBox;
 ```
 
 ### Parameters
 
-#### sw?
-
-\[`number`, `number`, `number`, `number`\] | `LngLatLike` | \[`LngLatLike`, `LngLatLike`\]
-
-#### ne?
-
-`LngLatLike`
+| Parameter | Type |
+| ------ | ------ |
+| `sw?` | \| \[`number`, `number`, `number`, `number`\] \| `LngLatLike` \| \[`LngLatLike`, `LngLatLike`\] |
+| `ne?` | `LngLatLike` |
 
 ### Returns
 
@@ -385,6 +422,8 @@ MapBox.LngLatBounds.constructor
 
 ***
 
+A Mercator coordinate extending MapBox LngLat.
+
 ## Extends
 
 - `LngLat`
@@ -394,18 +433,15 @@ MapBox.LngLatBounds.constructor
 ### Constructor
 
 ```ts
-new MercatorLngLat(lng, lat): MercatorLngLat;
+new MercatorLngLat(lng: number, lat: number): MercatorLngLat;
 ```
 
 ### Parameters
 
-#### lng
-
-`number`
-
-#### lat
-
-`number`
+| Parameter | Type |
+| ------ | ------ |
+| `lng` | `number` |
+| `lat` | `number` |
 
 ### Returns
 
@@ -426,19 +462,23 @@ MapBox.LngLat.constructor
 ***
 
 ```ts
-function boundingBoxToBoundary(box): MercatorBoundary;
+function boundingBoxToBoundary(box: MercatorBoundingBox): MercatorBoundary;
 ```
 
-## Parameters
+Converts a bounding box to an ordered boundary polygon (closed ring of corner points).
 
-### box
+## Parameters
 
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `box` | [`MercatorBoundingBox`](#../classes/MercatorBoundingBox) | The bounding box to convert |
 
 ## Returns
 
 [`MercatorBoundary`](#../type-aliases/MercatorBoundary)
 
+An array of corner points forming a closed boundary
+
   ### <a id="boundingBoxToCenter"></a>boundingBoxToCenter
 
 [**@xylabs/geo**](#../README)
@@ -446,23 +486,24 @@ function boundingBoxToBoundary(box): MercatorBoundary;
 ***
 
 ```ts
-function boundingBoxToCenter(boundingBox, decimal?): number[];
+function boundingBoxToCenter(boundingBox: MercatorBoundingBox, decimal?: number): number[];
 ```
 
-## Parameters
-
-### boundingBox
+Computes the center point of a bounding box as [lng, lat], rounded to the specified decimal places.
 
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-### decimal?
+## Parameters
 
-`number` = `6`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `boundingBox` | [`MercatorBoundingBox`](#../classes/MercatorBoundingBox) | `undefined` | The bounding box to find the center of |
+| `decimal` | `number` | `6` | Number of decimal places for rounding (default 6) |
 
 ## Returns
 
 `number`[]
 
+A [longitude, latitude] tuple representing the center
+
   ### <a id="boundingBoxToPolygon"></a>boundingBoxToPolygon
 
 [**@xylabs/geo**](#../README)
@@ -470,19 +511,23 @@ function boundingBoxToCenter(boundingBox, decimal?): number[];
 ***
 
 ```ts
-function boundingBoxToPolygon(box): Polygon;
+function boundingBoxToPolygon(box: MercatorBoundingBox): Polygon;
 ```
 
-## Parameters
+Converts a bounding box to a GeoJSON Polygon geometry.
 
-### box
+## Parameters
 
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `box` | [`MercatorBoundingBox`](#../classes/MercatorBoundingBox) | The bounding box to convert |
 
 ## Returns
 
 `Polygon`
 
+A GeoJSON Polygon representing the bounding box
+
   ### <a id="hasSiblings"></a>hasSiblings
 
 [**@xylabs/geo**](#../README)
@@ -490,23 +535,24 @@ function boundingBoxToPolygon(box): Polygon;
 ***
 
 ```ts
-function hasSiblings(tiles, tile): boolean;
+function hasSiblings(tiles: MercatorTile[], tile: MercatorTile): boolean;
 ```
 
-## Parameters
+Checks whether all four siblings of the given tile exist in the tile array.
 
-### tiles
-
-[`MercatorTile`](#../type-aliases/MercatorTile)[]
-
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tiles` | [`MercatorTile`](#../type-aliases/MercatorTile)[] | The array of tiles to search |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile whose siblings to check for |
 
 ## Returns
 
 `boolean`
 
+True if all siblings are present in the array
+
   ### <a id="tileFromPoint"></a>tileFromPoint
 
 [**@xylabs/geo**](#../README)
@@ -514,23 +560,24 @@ function hasSiblings(tiles, tile): boolean;
 ***
 
 ```ts
-function tileFromPoint(point, z): MercatorTile;
+function tileFromPoint(point: MercatorLngLat, z: number): MercatorTile;
 ```
 
-## Parameters
-
-### point
-
-[`MercatorLngLat`](#../classes/MercatorLngLat)
+Converts a geographic point to the integer Mercator tile containing it at the given zoom level.
 
-### z
+## Parameters
 
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `point` | [`MercatorLngLat`](#../classes/MercatorLngLat) | The geographic coordinate |
+| `z` | `number` | The zoom level |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
   ### <a id="tileFromQuadkey"></a>tileFromQuadkey
 
 [**@xylabs/geo**](#../README)
@@ -538,19 +585,23 @@ function tileFromPoint(point, z): MercatorTile;
 ***
 
 ```ts
-function tileFromQuadkey(quadkey): MercatorTile;
+function tileFromQuadkey(quadkey: string): MercatorTile;
 ```
 
-## Parameters
+Converts a quadkey string to a Mercator tile [x, y, zoom].
 
-### quadkey
+## Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `quadkey` | `string` | The quadkey string to decode |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
   ### <a id="tileToBoundingBox"></a>tileToBoundingBox
 
 [**@xylabs/geo**](#../README)
@@ -558,19 +609,23 @@ function tileFromQuadkey(quadkey): MercatorTile;
 ***
 
 ```ts
-function tileToBoundingBox(tile): MercatorBoundingBox;
+function tileToBoundingBox(tile: MercatorTile): MercatorBoundingBox;
 ```
 
-## Parameters
+Converts a Mercator tile to its geographic bounding box.
 
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [x, y, zoom] |
 
 ## Returns
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The bounding box covering the tile's geographic extent
+
   ### <a id="tileToChildren"></a>tileToChildren
 
 [**@xylabs/geo**](#../README)
@@ -578,19 +633,23 @@ function tileToBoundingBox(tile): MercatorBoundingBox;
 ***
 
 ```ts
-function tileToChildren(tile): MercatorTile[];
+function tileToChildren(tile: MercatorTile): MercatorTile[];
 ```
 
+Returns the four child tiles at one zoom level higher.
+
 ## Parameters
 
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The parent tile as [x, y, zoom] |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of four child tiles at zoom + 1
+
   ### <a id="tileToGeoJson"></a>tileToGeoJson
 
 [**@xylabs/geo**](#../README)
@@ -598,19 +657,23 @@ function tileToChildren(tile): MercatorTile[];
 ***
 
 ```ts
-function tileToGeoJson(tile): Polygon;
+function tileToGeoJson(tile: MercatorTile): Polygon;
 ```
 
+Converts a Mercator tile to a GeoJSON Polygon geometry.
+
 ## Parameters
 
-### tile
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [x, y, zoom] |
 
 ## Returns
 
 `Polygon`
 
+A GeoJSON Polygon representing the tile's geographic extent
+
   ### <a id="tileToParent"></a>tileToParent
 
 [**@xylabs/geo**](#../README)
@@ -618,19 +681,23 @@ function tileToGeoJson(tile): Polygon;
 ***
 
 ```ts
-function tileToParent(tile): MercatorTile;
+function tileToParent(tile: MercatorTile): MercatorTile;
 ```
 
-## Parameters
+Returns the parent tile at one zoom level lower.
 
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [x, y, zoom] |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The parent tile at zoom - 1
+
   ### <a id="tileToPoint"></a>tileToPoint
 
 [**@xylabs/geo**](#../README)
@@ -638,19 +705,23 @@ function tileToParent(tile): MercatorTile;
 ***
 
 ```ts
-function tileToPoint(tile): MercatorLngLat;
+function tileToPoint(tile: MercatorTile): MercatorLngLat;
 ```
 
-## Parameters
+Returns the center point of a Mercator tile.
 
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [x, y, zoom] |
 
 ## Returns
 
 [`MercatorLngLat`](#../classes/MercatorLngLat)
 
+The center coordinate as a MercatorLngLat
+
   ### <a id="tileToQuadkey"></a>tileToQuadkey
 
 [**@xylabs/geo**](#../README)
@@ -658,19 +729,23 @@ function tileToPoint(tile): MercatorLngLat;
 ***
 
 ```ts
-function tileToQuadkey(__namedParameters): string;
+function tileToQuadkey(param0: MercatorTile): string;
 ```
 
-## Parameters
+Converts a Mercator tile to its quadkey string representation.
 
-### \_\_namedParameters
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `param0` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [tileX, tileY, tileZoom] |
 
 ## Returns
 
 `string`
 
+The quadkey string encoding the tile's position and zoom
+
   ### <a id="tileToSiblings"></a>tileToSiblings
 
 [**@xylabs/geo**](#../README)
@@ -678,19 +753,23 @@ function tileToQuadkey(__namedParameters): string;
 ***
 
 ```ts
-function tileToSiblings(tile): MercatorTile[];
+function tileToSiblings(tile: MercatorTile): MercatorTile[];
 ```
 
-## Parameters
+Returns the four sibling tiles (children of the parent tile) for the given tile.
 
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile as [x, y, zoom] |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of four sibling tiles at the same zoom level
+
   ### <a id="tilesEqual"></a>tilesEqual
 
 [**@xylabs/geo**](#../README)
@@ -698,23 +777,24 @@ function tileToSiblings(tile): MercatorTile[];
 ***
 
 ```ts
-function tilesEqual(__namedParameters, __namedParameters): boolean;
+function tilesEqual(param0: MercatorTile, param1: MercatorTile): boolean;
 ```
 
-## Parameters
-
-### \_\_namedParameters
-
-[`MercatorTile`](#../type-aliases/MercatorTile)
+Checks whether two Mercator tiles are equal by comparing their x, y, and zoom values.
 
-### \_\_namedParameters
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `param0` | [`MercatorTile`](#../type-aliases/MercatorTile) | The first tile as [x, y, zoom] |
+| `param1` | [`MercatorTile`](#../type-aliases/MercatorTile) | The second tile as [x, y, zoom] |
 
 ## Returns
 
 `boolean`
 
+True if both tiles have identical coordinates and zoom
+
   ### <a id="tilesFromBoundingBox"></a>tilesFromBoundingBox
 
 [**@xylabs/geo**](#../README)
@@ -722,23 +802,24 @@ function tilesEqual(__namedParameters, __namedParameters): boolean;
 ***
 
 ```ts
-function tilesFromBoundingBox(box, zoom): MercatorTile[];
+function tilesFromBoundingBox(box: MercatorBoundingBox, zoom: number): MercatorTile[];
 ```
 
-## Parameters
+Returns all Mercator tiles that intersect the given bounding box at the specified zoom level.
 
-### box
-
-[`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
-
-### zoom
+## Parameters
 
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `box` | [`MercatorBoundingBox`](#../classes/MercatorBoundingBox) | The geographic bounding box |
+| `zoom` | `number` | The zoom level |
 
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of tiles covering the bounding box
+
   ### <a id="tilesHasTile"></a>tilesHasTile
 
 [**@xylabs/geo**](#../README)
@@ -746,23 +827,24 @@ function tilesFromBoundingBox(box, zoom): MercatorTile[];
 ***
 
 ```ts
-function tilesHasTile(tiles, tile): boolean;
+function tilesHasTile(tiles: MercatorTile[], tile: MercatorTile): boolean;
 ```
 
-## Parameters
-
-### tiles
+Checks whether a specific tile exists in the given tile array.
 
-[`MercatorTile`](#../type-aliases/MercatorTile)[]
-
-### tile
+## Parameters
 
-[`MercatorTile`](#../type-aliases/MercatorTile)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tiles` | [`MercatorTile`](#../type-aliases/MercatorTile)[] | The array of tiles to search |
+| `tile` | [`MercatorTile`](#../type-aliases/MercatorTile) | The tile to look for |
 
 ## Returns
 
 `boolean`
 
+True if the tile is found in the array
+
 ### type-aliases
 
   ### <a id="MercatorBoundary"></a>MercatorBoundary
@@ -775,6 +857,8 @@ function tilesHasTile(tiles, tile): boolean;
 type MercatorBoundary = MercatorLngLat[];
 ```
 
+An ordered array of MercatorLngLat points forming a boundary.
+
   ### <a id="MercatorTile"></a>MercatorTile
 
 [**@xylabs/geo**](#../README)
@@ -785,6 +869,8 @@ type MercatorBoundary = MercatorLngLat[];
 type MercatorTile = readonly [number, number, number];
 ```
 
+A Mercator tile represented as [x, y, zoom].
+
 ### variables
 
   ### <a id="d2r"></a>d2r
@@ -797,6 +883,8 @@ type MercatorTile = readonly [number, number, number];
 const d2r: number;
 ```
 
+Conversion factor from degrees to radians.
+
   ### <a id="r2d"></a>r2d
 
 [**@xylabs/geo**](#../README)
@@ -807,6 +895,8 @@ const d2r: number;
 const r2d: number;
 ```
 
+Conversion factor from radians to degrees.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)