@breadstone/archipel-mcp 0.0.1 → 0.0.2

package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md

@@ -3,11 +3,10 @@ title: 'Type Alias: ReportingFieldType'
 generated: true
 editUrl: false
 ---
-
 # Type Alias: ReportingFieldType
 
 ```ts
-type ReportingFieldType = (typeof ReportingFieldTypes)[keyof typeof ReportingFieldTypes];
+type ReportingFieldType = typeof ReportingFieldTypes[keyof typeof ReportingFieldTypes];
 ```
 
 Defined in: [models/ReportingDatasetField.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L18)

package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md

@@ -3,11 +3,10 @@ title: 'Type Alias: ReportingFilterOperator'
 generated: true
 editUrl: false
 ---
-
 # Type Alias: ReportingFilterOperator
 
 ```ts
-type ReportingFilterOperator = (typeof ReportingFilterOperators)[keyof typeof ReportingFilterOperators];
+type ReportingFilterOperator = typeof ReportingFilterOperators[keyof typeof ReportingFilterOperators];
 ```
 
 Defined in: [models/ReportingQuery.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L17)

package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md

@@ -3,7 +3,6 @@ title: 'Type Alias: ReportingQueryResultRow'
 generated: true
 editUrl: false
 ---
-
 # Type Alias: ReportingQueryResultRow
 
 ```ts

package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md

@@ -0,0 +1,30 @@
+---
+title: 'Variable: ReportingFieldTypes'
+generated: true
+editUrl: false
+---
+# Variable: ReportingFieldTypes
+
+```ts
+const ReportingFieldTypes: {
+  Boolean: "boolean";
+  DateTime: "datetime";
+  Json: "json";
+  Number: "number";
+  String: "string";
+};
+```
+
+Defined in: [models/ReportingDatasetField.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L10)
+
+Enumerates the supported field data types for reporting datasets.
+
+## Type Declaration
+
+| Name | Type | Default value | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="property-boolean"></a> `Boolean` | `"boolean"` | `'boolean'` | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
+| <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'` | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
+| <a id="property-json"></a> `Json` | `"json"` | `'json'` | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
+| <a id="property-number"></a> `Number` | `"number"` | `'number'` | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
+| <a id="property-string"></a> `String` | `"string"` | `'string'` | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |

package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md

@@ -0,0 +1,28 @@
+---
+title: 'Variable: ReportingFilterOperators'
+generated: true
+editUrl: false
+---
+# Variable: ReportingFilterOperators
+
+```ts
+const ReportingFilterOperators: {
+  Equals: "equals";
+  GreaterThanOrEqual: "gte";
+  In: "in";
+  LessThanOrEqual: "lte";
+};
+```
+
+Defined in: [models/ReportingQuery.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L10)
+
+Enumerates supported filter operators for dataset queries.
+
+## Type Declaration
+
+| Name | Type | Default value | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="property-equals"></a> `Equals` | `"equals"` | `'equals'` | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
+| <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"` | `'gte'` | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
+| <a id="property-in"></a> `In` | `"in"` | `'in'` | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
+| <a id="property-lessthanorequal"></a> `LessThanOrEqual` | `"lte"` | `'lte'` | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |

package/data/packages/platform-reporting/api/index.md

@@ -3,88 +3,40 @@ title: '@breadstone/archipel-platform-reporting'
 generated: true
 editUrl: false
 ---
-
 # @breadstone/archipel-platform-reporting
 
 ## Classes
 
-| Class                                                                | Description                                                                          |
-| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| [ReportingContributorRegistry](Class.ReportingContributorRegistry)   | Registry responsible for tracking feature-provided reporting contributors.           |
-| [ReportingDatasetNotFoundError](Class.ReportingDatasetNotFoundError) | Error thrown when a dataset definition could not be resolved.                        |
-| [ReportingFacade](Class.ReportingFacade)                             | Facade orchestrating dataset resolution and query execution for reporting consumers. |
-| [ReportingModule](Class.ReportingModule)                             | Global module providing the reporting facade and contributor registry.               |
+| Class | Description |
+| ------ | ------ |
+| [ReportingContributorRegistry](Class.ReportingContributorRegistry) | Registry responsible for tracking feature-provided reporting contributors. |
+| [ReportingDatasetNotFoundError](Class.ReportingDatasetNotFoundError) | Error thrown when a dataset definition could not be resolved. |
+| [ReportingFacade](Class.ReportingFacade) | Facade orchestrating dataset resolution and query execution for reporting consumers. |
+| [ReportingModule](Class.ReportingModule) | Global module providing the reporting facade and contributor registry. |
 
 ## Interfaces
 
-| Interface                                                  | Description                                                                     |
-| ---------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| [IReportingContributor](Interface.IReportingContributor)   | Describes a feature-level contributor that exposes reporting datasets.          |
-| [IReportingDataset](Interface.IReportingDataset)           | Represents a dataset definition that can be consumed through the reporting API. |
-| [IReportingDatasetField](Interface.IReportingDatasetField) | Describes a single field inside a reporting dataset.                            |
-| [IReportingQuery](Interface.IReportingQuery)               | Represents an execution request for a dataset query.                            |
-| [IReportingQueryFilter](Interface.IReportingQueryFilter)   | Describes a single filter applied to a dataset query execution.                 |
-| [IReportingQueryResult](Interface.IReportingQueryResult)   | Represents the result of a dataset query execution.                             |
-| [IReportingQuerySort](Interface.IReportingQuerySort)       | Represents a sorting instruction for a dataset query.                           |
+| Interface | Description |
+| ------ | ------ |
+| [IReportingContributor](Interface.IReportingContributor) | Describes a feature-level contributor that exposes reporting datasets. |
+| [IReportingDataset](Interface.IReportingDataset) | Represents a dataset definition that can be consumed through the reporting API. |
+| [IReportingDatasetField](Interface.IReportingDatasetField) | Describes a single field inside a reporting dataset. |
+| [IReportingQuery](Interface.IReportingQuery) | Represents an execution request for a dataset query. |
+| [IReportingQueryFilter](Interface.IReportingQueryFilter) | Describes a single filter applied to a dataset query execution. |
+| [IReportingQueryResult](Interface.IReportingQueryResult) | Represents the result of a dataset query execution. |
+| [IReportingQuerySort](Interface.IReportingQuerySort) | Represents a sorting instruction for a dataset query. |
 
 ## Type Aliases
 
-| Type Alias                                                   | Description                                              |
-| ------------------------------------------------------------ | -------------------------------------------------------- |
-| [ReportingFieldType](TypeAlias.ReportingFieldType)           | -                                                        |
-| [ReportingFilterOperator](TypeAlias.ReportingFilterOperator) | -                                                        |
+| Type Alias | Description |
+| ------ | ------ |
+| [ReportingFieldType](TypeAlias.ReportingFieldType) | - |
+| [ReportingFilterOperator](TypeAlias.ReportingFilterOperator) | - |
 | [ReportingQueryResultRow](TypeAlias.ReportingQueryResultRow) | Represents a single row returned by a reporting dataset. |
 
 ## Variables
 
-### ReportingFieldTypes
-
-```ts
-const ReportingFieldTypes: {
-  Boolean: 'boolean';
-  DateTime: 'datetime';
-  Json: 'json';
-  Number: 'number';
-  String: 'string';
-};
-```
-
-Defined in: [models/ReportingDatasetField.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L10)
-
-Enumerates the supported field data types for reporting datasets.
-
-#### Type Declaration
-
-| Name                                      | Type         | Default value | Defined in                                                                                                                                              |
-| ----------------------------------------- | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-boolean"></a> `Boolean`   | `"boolean"`  | `'boolean'`   | [models/ReportingDatasetField.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L11) |
-| <a id="property-datetime"></a> `DateTime` | `"datetime"` | `'datetime'`  | [models/ReportingDatasetField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L12) |
-| <a id="property-json"></a> `Json`         | `"json"`     | `'json'`      | [models/ReportingDatasetField.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L13) |
-| <a id="property-number"></a> `Number`     | `"number"`   | `'number'`    | [models/ReportingDatasetField.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L14) |
-| <a id="property-string"></a> `String`     | `"string"`   | `'string'`    | [models/ReportingDatasetField.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L15) |
-
----
-
-### ReportingFilterOperators
-
-```ts
-const ReportingFilterOperators: {
-  Equals: 'equals';
-  GreaterThanOrEqual: 'gte';
-  In: 'in';
-  LessThanOrEqual: 'lte';
-};
-```
-
-Defined in: [models/ReportingQuery.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L10)
-
-Enumerates supported filter operators for dataset queries.
-
-#### Type Declaration
-
-| Name                                                          | Type       | Default value | Defined in                                                                                                                                |
-| ------------------------------------------------------------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-equals"></a> `Equals`                         | `"equals"` | `'equals'`    | [models/ReportingQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L11) |
-| <a id="property-greaterthanorequal"></a> `GreaterThanOrEqual` | `"gte"`    | `'gte'`       | [models/ReportingQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L12) |
-| <a id="property-in"></a> `In`                                 | `"in"`     | `'in'`        | [models/ReportingQuery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L13) |
-| <a id="property-lessthanorequal"></a> `LessThanOrEqual`       | `"lte"`    | `'lte'`       | [models/ReportingQuery.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L14) |
+| Variable | Description |
+| ------ | ------ |
+| [ReportingFieldTypes](Variable.ReportingFieldTypes) | Enumerates the supported field data types for reporting datasets. |
+| [ReportingFilterOperators](Variable.ReportingFilterOperators) | Enumerates supported filter operators for dataset queries. |

package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md

@@ -3,11 +3,6 @@ title: 'Class: NoopTelemetryFacade'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-telemetry**](../)
-
----
-
 # Class: NoopTelemetryFacade
 
 Defined in: [core/NoopTelemetryFacade.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/NoopTelemetryFacade.ts#L11)
@@ -40,12 +35,12 @@ Defined in: [core/NoopTelemetryFacade.ts:14](https://github.com/RueDeRennes/arch
 
 #### Parameters
 
-| Parameter   | Type                                                              |
-| ----------- | ----------------------------------------------------------------- |
-| `_`         | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
-| `_.cache`   | `string`                                                          |
-| `_.outcome` | `string`                                                          |
-| `_.phase?`  | `string`                                                          |
+| Parameter | Type |
+| ------ | ------ |
+| `_` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
+| `_.cache` | `string` |
+| `_.outcome` | `string` |
+| `_.phase?` | `string` |
 
 #### Returns
 
@@ -55,15 +50,15 @@ Defined in: [core/NoopTelemetryFacade.ts:14](https://github.com/RueDeRennes/arch
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordCacheEvent`](Interface.ITelemetryFacade#recordcacheevent)
 
----
+***
 
 ### recordClientMetric()?
 
 ```ts
 optional recordClientMetric(
-   name,
-   type,
-   value,
+   name, 
+   type, 
+   value, 
    _labels?): void;
 ```
 
@@ -71,11 +66,11 @@ Defined in: [core/NoopTelemetryFacade.ts:19](https://github.com/RueDeRennes/arch
 
 #### Parameters
 
-| Parameter  | Type                           |
-| ---------- | ------------------------------ |
-| `name`     | `string`                       |
-| `type`     | `string`                       |
-| `value`    | `number`                       |
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `type` | `string` |
+| `value` | `number` |
 | `_labels?` | `Record`\<`string`, `string`\> |
 
 #### Returns
@@ -86,7 +81,7 @@ Defined in: [core/NoopTelemetryFacade.ts:19](https://github.com/RueDeRennes/arch
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordClientMetric`](Interface.ITelemetryFacade#recordclientmetric)
 
----
+***
 
 ### runOperation()
 
@@ -99,15 +94,15 @@ Defined in: [core/NoopTelemetryFacade.ts:13](https://github.com/RueDeRennes/arch
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 #### Parameters
 
-| Parameter | Type                          |
-| --------- | ----------------------------- |
-| `_`       | `string`                      |
-| `fn`      | () => `T` \| `Promise`\<`T`\> |
+| Parameter | Type |
+| ------ | ------ |
+| `_` | `string` |
+| `fn` | () => `T` \| `Promise`\<`T`\> |
 
 #### Returns
 

package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md

@@ -3,11 +3,6 @@ title: 'Class: TelemetryCacheMetricsRecorder'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-telemetry**](../)
-
----
-
 # Class: TelemetryCacheMetricsRecorder
 
 Defined in: [core/TelemetryCacheMetricsRecorder.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/TelemetryCacheMetricsRecorder.ts#L15)
@@ -31,8 +26,8 @@ Defined in: [core/TelemetryCacheMetricsRecorder.ts:21](https://github.com/RueDeR
 
 #### Parameters
 
-| Parameter   | Type                                             |
-| ----------- | ------------------------------------------------ |
+| Parameter | Type |
+| ------ | ------ |
 | `telemetry` | [`ITelemetryFacade`](Interface.ITelemetryFacade) |
 
 #### Returns
@@ -53,9 +48,9 @@ Records a cache eviction.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
@@ -64,10 +59,10 @@ Records a cache eviction.
 #### Implementation of
 
 ```ts
-ICacheMetricsRecorder.recordEviction;
+ICacheMetricsRecorder.recordEviction
 ```
 
----
+***
 
 ### recordHit()
 
@@ -81,9 +76,9 @@ Records a cache hit.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
@@ -92,10 +87,10 @@ Records a cache hit.
 #### Implementation of
 
 ```ts
-ICacheMetricsRecorder.recordHit;
+ICacheMetricsRecorder.recordHit
 ```
 
----
+***
 
 ### recordLoadError()
 
@@ -109,9 +104,9 @@ Records a failed cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
@@ -120,10 +115,10 @@ Records a failed cache load.
 #### Implementation of
 
 ```ts
-ICacheMetricsRecorder.recordLoadError;
+ICacheMetricsRecorder.recordLoadError
 ```
 
----
+***
 
 ### recordLoadSuccess()
 
@@ -137,9 +132,9 @@ Records a successful cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
@@ -148,10 +143,10 @@ Records a successful cache load.
 #### Implementation of
 
 ```ts
-ICacheMetricsRecorder.recordLoadSuccess;
+ICacheMetricsRecorder.recordLoadSuccess
 ```
 
----
+***
 
 ### recordMiss()
 
@@ -165,9 +160,9 @@ Records a cache miss.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
@@ -176,5 +171,5 @@ Records a cache miss.
 #### Implementation of
 
 ```ts
-ICacheMetricsRecorder.recordMiss;
+ICacheMetricsRecorder.recordMiss
 ```

package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md

@@ -3,11 +3,6 @@ title: 'Class: TelemetryFacade'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-telemetry**](../)
-
----
-
 # Class: TelemetryFacade
 
 Defined in: [core/TelemetryFacade.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/core/TelemetryFacade.ts#L3)
@@ -42,7 +37,7 @@ Defined in: [core/TelemetryFacade.ts:45](https://github.com/RueDeRennes/archipel
 
 `Logger`
 
----
+***
 
 ### recordCacheEvent()
 
@@ -54,12 +49,12 @@ Defined in: [core/TelemetryFacade.ts:25](https://github.com/RueDeRennes/archipel
 
 #### Parameters
 
-| Parameter       | Type                                                              |
-| --------------- | ----------------------------------------------------------------- |
-| `event`         | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
-| `event.cache`   | `string`                                                          |
-| `event.outcome` | `string`                                                          |
-| `event.phase?`  | `string`                                                          |
+| Parameter | Type |
+| ------ | ------ |
+| `event` | \{ `cache`: `string`; `outcome`: `string`; `phase?`: `string`; \} |
+| `event.cache` | `string` |
+| `event.outcome` | `string` |
+| `event.phase?` | `string` |
 
 #### Returns
 
@@ -69,15 +64,15 @@ Defined in: [core/TelemetryFacade.ts:25](https://github.com/RueDeRennes/archipel
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordCacheEvent`](Interface.ITelemetryFacade#recordcacheevent)
 
----
+***
 
 ### recordClientMetric()
 
 ```ts
 recordClientMetric(
-   name,
-   type,
-   value,
+   name, 
+   type, 
+   value, 
    labels?): void;
 ```
 
@@ -85,11 +80,11 @@ Defined in: [core/TelemetryFacade.ts:35](https://github.com/RueDeRennes/archipel
 
 #### Parameters
 
-| Parameter | Type                           |
-| --------- | ------------------------------ |
-| `name`    | `string`                       |
-| `type`    | `string`                       |
-| `value`   | `number`                       |
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `type` | `string` |
+| `value` | `number` |
 | `labels?` | `Record`\<`string`, `string`\> |
 
 #### Returns
@@ -100,7 +95,7 @@ Defined in: [core/TelemetryFacade.ts:35](https://github.com/RueDeRennes/archipel
 
 [`ITelemetryFacade`](Interface.ITelemetryFacade).[`recordClientMetric`](Interface.ITelemetryFacade#recordclientmetric)
 
----
+***
 
 ### runOperation()
 
@@ -113,15 +108,15 @@ Defined in: [core/TelemetryFacade.ts:7](https://github.com/RueDeRennes/archipel/
 #### Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 #### Parameters
 
-| Parameter | Type                          |
-| --------- | ----------------------------- |
-| `name`    | `string`                      |
-| `fn`      | () => `T` \| `Promise`\<`T`\> |
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `fn` | () => `T` \| `Promise`\<`T`\> |
 
 #### Returns