@isdk/web-fetcher 0.2.0

package/docs/interfaces/DispatchedEngineAction.md

@@ -0,0 +1,60 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / DispatchedEngineAction
+
+# Interface: DispatchedEngineAction
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:96](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L96)
+
+Represents an action that has been dispatched and is awaiting execution in the active page context.
+
+## Remarks
+
+Connects the action request with its resolution mechanism. Used internally by the action dispatch system
+to handle promises while maintaining the page context validity window.
+
+## Properties
+
+### action
+
+> **action**: [`FetchEngineAction`](../type-aliases/FetchEngineAction.md)
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:97](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L97)
+
+***
+
+### reject()
+
+> **reject**: (`reason?`) => `void`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:99](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L99)
+
+#### Parameters
+
+##### reason?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### resolve()
+
+> **resolve**: (`value?`) => `void`
+
+Defined in: [packages/web-fetcher/src/engine/base.ts:98](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/engine/base.ts#L98)
+
+#### Parameters
+
+##### value?
+
+`any`
+
+#### Returns
+
+`void`

package/docs/interfaces/ExtractActionProperties.md

@@ -0,0 +1,113 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / ExtractActionProperties
+
+# Interface: ExtractActionProperties
+
+Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:5](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/definitions/extract.ts#L5)
+
+## Extends
+
+- [`BaseFetchActionProperties`](BaseFetchActionProperties.md)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### failOnError?
+
+> `optional` **failOnError**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L52)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnError`](BaseFetchActionProperties.md#failonerror)
+
+***
+
+### failOnTimeout?
+
+> `optional` **failOnTimeout**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L54)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnTimeout`](BaseFetchActionProperties.md#failontimeout)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L45)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`id`](BaseFetchActionProperties.md#id)
+
+***
+
+### maxRetries?
+
+> `optional` **maxRetries**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L56)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`maxRetries`](BaseFetchActionProperties.md#maxretries)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L46)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`name`](BaseFetchActionProperties.md#name)
+
+***
+
+### params
+
+> **params**: `ExtractSchema`
+
+Defined in: [packages/web-fetcher/src/action/definitions/extract.ts:6](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/definitions/extract.ts#L6)
+
+#### Overrides
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`params`](BaseFetchActionProperties.md#params)
+
+***
+
+### storeAs?
+
+> `optional` **storeAs**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L49)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`storeAs`](BaseFetchActionProperties.md#storeas)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L55)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`timeoutMs`](BaseFetchActionProperties.md#timeoutms)

package/docs/interfaces/FetchActionInContext.md

@@ -0,0 +1,149 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionInContext
+
+# Interface: FetchActionInContext
+
+Defined in: [packages/web-fetcher/src/core/context.ts:7](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L7)
+
+## Extends
+
+- [`FetchActionProperties`](FetchActionProperties.md)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### collectors?
+
+> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"`\>[]
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:75](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L75)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`collectors`](FetchActionProperties.md#collectors)
+
+***
+
+### depth?
+
+> `optional` **depth**: `number`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:10](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L10)
+
+***
+
+### error?
+
+> `optional` **error**: `Error`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:9](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L9)
+
+***
+
+### failOnError?
+
+> `optional` **failOnError**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L52)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`failOnError`](FetchActionProperties.md#failonerror)
+
+***
+
+### failOnTimeout?
+
+> `optional` **failOnTimeout**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L54)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`failOnTimeout`](FetchActionProperties.md#failontimeout)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L45)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`id`](FetchActionProperties.md#id)
+
+***
+
+### index?
+
+> `optional` **index**: `number`
+
+Defined in: [packages/web-fetcher/src/core/context.ts:8](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/core/context.ts#L8)
+
+***
+
+### maxRetries?
+
+> `optional` **maxRetries**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L56)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`maxRetries`](FetchActionProperties.md#maxretries)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L46)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`name`](FetchActionProperties.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: `any`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L47)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`params`](FetchActionProperties.md#params)
+
+***
+
+### storeAs?
+
+> `optional` **storeAs**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L49)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`storeAs`](FetchActionProperties.md#storeas)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L55)
+
+#### Inherited from
+
+[`FetchActionProperties`](FetchActionProperties.md).[`timeoutMs`](FetchActionProperties.md#timeoutms)

package/docs/interfaces/FetchActionProperties.md

@@ -0,0 +1,125 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionProperties
+
+# Interface: FetchActionProperties
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:74](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L74)
+
+## Extends
+
+- [`BaseFetchActionProperties`](BaseFetchActionProperties.md)
+
+## Extended by
+
+- [`FetchActionInContext`](FetchActionInContext.md)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### collectors?
+
+> `optional` **collectors**: `_RequireAtLeastOne`\<[`BaseFetchCollectorActionProperties`](BaseFetchCollectorActionProperties.md), `"name"` \| `"id"`\>[]
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:75](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L75)
+
+***
+
+### failOnError?
+
+> `optional` **failOnError**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:52](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L52)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnError`](BaseFetchActionProperties.md#failonerror)
+
+***
+
+### failOnTimeout?
+
+> `optional` **failOnTimeout**: `boolean`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:54](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L54)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`failOnTimeout`](BaseFetchActionProperties.md#failontimeout)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:45](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L45)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`id`](BaseFetchActionProperties.md#id)
+
+***
+
+### maxRetries?
+
+> `optional` **maxRetries**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:56](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L56)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`maxRetries`](BaseFetchActionProperties.md#maxretries)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:46](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L46)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`name`](BaseFetchActionProperties.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: `any`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:47](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L47)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`params`](BaseFetchActionProperties.md#params)
+
+***
+
+### storeAs?
+
+> `optional` **storeAs**: `string`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:49](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L49)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`storeAs`](BaseFetchActionProperties.md#storeas)
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:55](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L55)
+
+#### Inherited from
+
+[`BaseFetchActionProperties`](BaseFetchActionProperties.md).[`timeoutMs`](BaseFetchActionProperties.md#timeoutms)

package/docs/interfaces/FetchActionResult.md

@@ -0,0 +1,55 @@
+[**@isdk/web-fetcher**](../README.md)
+
+***
+
+[@isdk/web-fetcher](../globals.md) / FetchActionResult
+
+# Interface: FetchActionResult\<R\>
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:36](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L36)
+
+## Type Parameters
+
+### R
+
+`R` *extends* [`FetchReturnType`](../type-aliases/FetchReturnType.md) = [`FetchReturnType`](../type-aliases/FetchReturnType.md)
+
+## Properties
+
+### error?
+
+> `optional` **error**: `Error`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:40](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L40)
+
+***
+
+### meta?
+
+> `optional` **meta**: `FetchActionMeta`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:41](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L41)
+
+***
+
+### result?
+
+> `optional` **result**: [`FetchReturnTypeFor`](../type-aliases/FetchReturnTypeFor.md)\<`R`\>
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:39](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L39)
+
+***
+
+### returnType?
+
+> `optional` **returnType**: `R`
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:38](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L38)
+
+***
+
+### status
+
+> **status**: [`FetchActionResultStatus`](../enumerations/FetchActionResultStatus.md)
+
+Defined in: [packages/web-fetcher/src/action/fetch-action.ts:37](https://github.com/isdk/web-fetcher.js/blob/ef3a4e527bf3ca75213d55b02c017b9a30a036fd/src/action/fetch-action.ts#L37)