Update typedoc (#24)

felt · Jan 31, 2025 · 5e8bda4 · 5e8bda4
1 parent c20e605
commit 5e8bda4
Show file tree

Hide file tree

Showing 27 changed files with 287 additions and 470 deletions.
diff --git a/docs/Elements/ElementsController.md b/docs/Elements/ElementsController.md
@@ -172,18 +172,18 @@ felt.setElementGroupVisibility({ show: ["element-group-1", "element-group-2"], h
 
 ### onElementChange()
 
-> **onElementChange**(`args`: \{`options`: \{`id`: `string`; };`handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; }): `VoidFunction`
+> **onElementChange**(`args`: \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; }): `VoidFunction`
 
 Adds a listener for when an element changes.
 
 #### Parameters
 
-| Parameter         | Type                                                                                  | Description                                          |
-| ----------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------- |
-| `args`            | `object`                                                                              | -                                                    |
-| `args.options`    | `object`                                                                              | -                                                    |
-| `args.options.id` | `string`                                                                              | The id of the element to listen for changes to.      |
-| `args.handler`    | (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void` | The handler that is called when the element changes. |
+| Parameter         | Type                                                                                                                                    | Description                                          |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| `args`            | \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; } | -                                                    |
+| `args.options`    | \{ `id`: `string`; }                                                                                                                    | -                                                    |
+| `args.options.id` | `string`                                                                                                                                | The id of the element to listen for changes to.      |
+| `args.handler`    | (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`                                                   | The handler that is called when the element changes. |
 
 #### Returns
 
@@ -207,18 +207,18 @@ unsubscribe();
 
 ### onElementGroupChange()
 
-> **onElementGroupChange**(`args`: \{`options`: \{`id`: `string`; };`handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; }): `VoidFunction`
+> **onElementGroupChange**(`args`: \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; }): `VoidFunction`
 
 Adds a listener for when an element group changes.
 
 #### Parameters
 
-| Parameter         | Type                                                                                            |
-| ----------------- | ----------------------------------------------------------------------------------------------- |
-| `args`            | `object`                                                                                        |
-| `args.options`    | `object`                                                                                        |
-| `args.options.id` | `string`                                                                                        |
-| `args.handler`    | (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void` |
+| Parameter         | Type                                                                                                                                              |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `args`            | \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; } |
+| `args.options`    | \{ `id`: `string`; }                                                                                                                              |
+| `args.options.id` | `string`                                                                                                                                          |
+| `args.handler`    | (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`                                                   |
 
 #### Returns
 

diff --git a/docs/Elements/README.md b/docs/Elements/README.md
@@ -3,19 +3,17 @@
 The Felt SDK lets you get information about the elements in the map, and the
 groups that they belong to.
 
-## Index
-
-### Controller
+## Controller
 
 * [ElementsController](ElementsController.md)
 
-### Element Groups
+## Element Groups
 
 * [ElementGroup](ElementGroup.md)
 * [GetElementGroupsConstraint](GetElementGroupsConstraint.md)
 * [ElementGroupChangeCallbackParams](ElementGroupChangeCallbackParams.md)
 
-### Elements
+## Elements
 
 * [Element](Element.md)
 * [GetElementsConstraint](GetElementsConstraint.md)

diff --git a/docs/Interactions/InteractionsController.md b/docs/Interactions/InteractionsController.md
@@ -10,16 +10,16 @@ The Interactions controller allows you to observe interactions with the map
 
 ### onPointerClick()
 
-> **onPointerClick**(`params`: \{`handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
+> **onPointerClick**(`params`: \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
 
 Allows you to be notified the user clicks on the map.
 
 #### Parameters
 
-| Parameter        | Type                                                                 |
-| ---------------- | -------------------------------------------------------------------- |
-| `params`         | `object`                                                             |
-| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` |
+| Parameter        | Type                                                                                  |
+| ---------------- | ------------------------------------------------------------------------------------- |
+| `params`         | \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; } |
+| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`                  |
 
 #### Returns
 
@@ -42,16 +42,16 @@ unsubscribe();
 
 ### onPointerMove()
 
-> **onPointerMove**(`params`: \{`handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
+> **onPointerMove**(`params`: \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
 
 Allows you to be notified the user moves the mouse over the map.
 
 #### Parameters
 
-| Parameter        | Type                                                                 | Description             |
-| ---------------- | -------------------------------------------------------------------- | ----------------------- |
-| `params`         | `object`                                                             | Params for the listener |
-| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` | The handler function    |
+| Parameter        | Type                                                                                  | Description             |
+| ---------------- | ------------------------------------------------------------------------------------- | ----------------------- |
+| `params`         | \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; } | Params for the listener |
+| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`                  | The handler function    |
 
 #### Returns
 

diff --git a/docs/Interactions/README.md b/docs/Interactions/README.md
@@ -4,12 +4,10 @@ The Interactions module allows you to be notified when the user interacts with t
 
 Interactions include clicking and hovering on points and features.
 
-## Index
-
-### Interfaces
+## Interfaces
 
 * [MapInteractionEvent](MapInteractionEvent.md)
 
-### Controller
+## Controller
 
 * [InteractionsController](InteractionsController.md)
diff --git a/docs/Layers/GetRenderedFeaturesConstraint.md b/docs/Layers/GetRenderedFeaturesConstraint.md
@@ -7,7 +7,7 @@ provided, all rendered features will be returned.
 
 ### areaQuery?
 
-> `optional` **areaQuery**: \{`coordinates`: [`LatLng`](../Shared/LatLng.md); } | \{`boundary`: \[`number`, `number`, `number`, `number`]; }
+> `optional` **areaQuery**: \{ `coordinates`: [`LatLng`](../Shared/LatLng.md); } | \{ `boundary`: \[`number`, `number`, `number`, `number`]; }
 
 The area to query for rendered features. This can be specific coordinates or a [FeltBoundary](../Shared/FeltBoundary.md). If omitted, the entire viewport will be queried.