@genesislcap/foundation-state-machine 14.225.1 → 14.225.2-alpha-a51f60c.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. package/dist/dts/core/binding.d.ts.map +1 -1
  2. package/dist/dts/core/guards.d.ts.map +1 -1
  3. package/dist/dts/machines/fetch/types.d.ts.map +1 -1
  4. package/dist/esm/machines/fetch/machine.js +6 -6
  5. package/dist/foundation-state-machine.api.json +769 -236
  6. package/dist/foundation-state-machine.d.ts +3 -3
  7. package/dist/{dts/tsdoc-metadata.json → tsdoc-metadata.json} +1 -1
  8. package/docs/api/foundation-state-machine.createerrorstatenode.md +14 -1
  9. package/docs/api/foundation-state-machine.createfetchpolicy.md +15 -1
  10. package/docs/api/foundation-state-machine.createresponsedataextractorwithdeserializer.md +13 -1
  11. package/docs/api/foundation-state-machine.errorworkflowinput.md +8 -6
  12. package/docs/api/foundation-state-machine.isaborterror.md +12 -1
  13. package/docs/api/foundation-state-machine.isactorerrorevent.md +13 -1
  14. package/docs/api/foundation-state-machine.isapierror.md +12 -1
  15. package/docs/api/foundation-state-machine.isdoneinvokeevent.md +12 -1
  16. package/docs/api/foundation-state-machine.iserrorcustomevent.md +11 -1
  17. package/docs/api/foundation-state-machine.iserrorevent.md +12 -1
  18. package/docs/api/foundation-state-machine.iserrortype.md +12 -1
  19. package/docs/api/foundation-state-machine.iseventwithparams.md +12 -1
  20. package/docs/api/foundation-state-machine.isgenesisservererror.md +12 -1
  21. package/docs/api/foundation-state-machine.ismappingerror.md +12 -1
  22. package/docs/api/foundation-state-machine.isnetworkerror.md +12 -1
  23. package/docs/api/foundation-state-machine.isnotfounderror.md +12 -1
  24. package/docs/api/foundation-state-machine.issyntaxerror.md +12 -1
  25. package/docs/api/foundation-state-machine.istypeerror.md +12 -1
  26. package/docs/api/foundation-state-machine.isunauthorizederror.md +12 -1
  27. package/docs/api/foundation-state-machine.md +20 -20
  28. package/docs/api/foundation-state-machine.seterrorbykey.md +11 -1
  29. package/docs/{api-report.md → api-report.md.api.md} +3 -3
  30. package/package.json +13 -13
@@ -27,7 +27,7 @@ import { IRetryContext } from 'cockatiel';
27
27
  import { Logger } from '@genesislcap/foundation-logger';
28
28
  import { MachineContext as MachineContext_2 } from 'xstate';
29
29
  import { Message } from '@genesislcap/foundation-comms';
30
- import type { NoInfer } from 'xstate';
30
+ import type { NoInfer as NoInfer_2 } from 'xstate';
31
31
  import { ParameterizedObject } from 'xstate';
32
32
  import { PropertyAssigner } from 'xstate';
33
33
  import type { ProvidedActor } from 'xstate';
@@ -48,7 +48,7 @@ import { UnifiedArg } from 'xstate';
48
48
  * AbstractMachine base class.
49
49
  * @public
50
50
  */
51
- export declare abstract class AbstractMachine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer<TEvent>, TAction, TActor>> implements Machine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta> {
51
+ export declare abstract class AbstractMachine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer_2<TEvent>, TAction, TActor>> implements Machine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta> {
52
52
  /**
53
53
  * @internal
54
54
  */
@@ -596,7 +596,7 @@ export declare const logger: Logger;
596
596
  *
597
597
  * @public
598
598
  */
599
- export declare interface Machine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer<TEvent>, TAction, TActor>> {
599
+ export declare interface Machine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer_2<TEvent>, TAction, TActor>> {
600
600
  /**
601
601
  * Mandatory machine property.
602
602
  * @remarks
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.34.9"
8
+ "packageVersion": "7.48.0"
9
9
  }
10
10
  ]
11
11
  }
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [createErrorStateNode](./foundation-state-machine.createerrorstatenode.md)
4
4
 
5
- ## createErrorStateNode variable
5
+ ## createErrorStateNode() function
6
6
 
7
7
  Creates an error state node.
8
8
 
@@ -11,3 +11,16 @@ Creates an error state node.
11
11
  ```typescript
12
12
  createErrorStateNode: (key: string, metaContent?: string, final?: boolean) => StateNodeConfig<any, any, any, any>
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | key | string | An error state key. |
20
+ | metaContent | string | _(Optional)_ An optional meta content value. |
21
+ | final | boolean | _(Optional)_ An optional flag which adds final with output functionality. |
22
+
23
+ **Returns:**
24
+
25
+ StateNodeConfig&lt;any, any, any, any&gt;
26
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [createFetchPolicy](./foundation-state-machine.createfetchpolicy.md)
4
4
 
5
- ## createFetchPolicy variable
5
+ ## createFetchPolicy() function
6
6
 
7
7
  A fetch policy factory.
8
8
 
@@ -12,6 +12,20 @@ A fetch policy factory.
12
12
  createFetchPolicy: (maxAttempts?: number, retryCodes?: StatusCodes[] | number[], backoff?: IBackoffFactory<IRetryBackoffContext<unknown>>, timeoutDuration?: number, logEvents?: boolean) => import("cockatiel").IMergedPolicy<import("cockatiel").IRetryContext & import("cockatiel").ICancellationContext, never, [import("cockatiel").RetryPolicy, import("cockatiel").TimeoutPolicy]>
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | maxAttempts | number | _(Optional)_ Max attempts. Defaults to <code>2</code>. |
20
+ | retryCodes | StatusCodes\[\] \| number\[\] | _(Optional)_ Status code array to retry. Defaults to [defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md)<!-- -->. |
21
+ | backoff | IBackoffFactory&lt;IRetryBackoffContext&lt;unknown&gt;&gt; | _(Optional)_ Backoff algo. Defaults to . |
22
+ | timeoutDuration | number | _(Optional)_ Timeout duration. Defaults to 3 seconds. |
23
+ | logEvents | boolean | _(Optional)_ Log events to the console. Defaults to <code>true</code>. |
24
+
25
+ **Returns:**
26
+
27
+ import("cockatiel").IMergedPolicy&lt;import("cockatiel").IRetryContext &amp; import("cockatiel").ICancellationContext, never, \[import("cockatiel").RetryPolicy, import("cockatiel").TimeoutPolicy\]&gt;
28
+
15
29
  ## Remarks
16
30
 
17
31
  Will retry network errors and responses with certain status codes up to the specified max attempts.
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [createResponseDataExtractorWithDeserializer](./foundation-state-machine.createresponsedataextractorwithdeserializer.md)
4
4
 
5
- ## createResponseDataExtractorWithDeserializer variable
5
+ ## createResponseDataExtractorWithDeserializer() function
6
6
 
7
7
  Creates an extractor that applies a deserializer to the extracted response data.
8
8
 
@@ -11,3 +11,15 @@ Creates an extractor that applies a deserializer to the extracted response data.
11
11
  ```typescript
12
12
  createResponseDataExtractorWithDeserializer: <TInput = any, TOutput = any>(deserializer: (data: TInput) => Promise<TOutput>, extractor?: ResponseDataExtractor) => ResponseDataExtractor
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | deserializer | (data: TInput) =&gt; Promise&lt;TOutput&gt; | The deserializer to apply. |
20
+ | extractor | [ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md) | _(Optional)_ An optional data extractor. Defaults to [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md)<!-- -->. |
21
+
22
+ **Returns:**
23
+
24
+ [ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md)
25
+
@@ -1,15 +1,17 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md)
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [ErrorWorkflowInput](./foundation-state-machine.errorworkflowinput.md)
4
4
 
5
- ## errorWorkflowInput variable
5
+ ## ErrorWorkflowInput type
6
6
 
7
- Error workflow input.
7
+ ErrorWorkflowInput type.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- errorWorkflowInput: (key: string) => ({ context }: {
13
- context: any;
14
- }) => ErrorWorkflowInput
12
+ export type ErrorWorkflowInput = {
13
+ errorKey: string;
14
+ errorValue: any;
15
+ errorMap: ErrorMap<ErrorDetailMap>;
16
+ };
15
17
  ```
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isAbortError](./foundation-state-machine.isaborterror.md)
4
4
 
5
- ## isAbortError variable
5
+ ## isAbortError() function
6
6
 
7
7
  isAbortError.
8
8
 
@@ -13,3 +13,14 @@ isAbortError: ({ event }: {
13
13
  event: any;
14
14
  }) => boolean
15
15
  ```
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type | Description |
20
+ | --- | --- | --- |
21
+ | { event } | { event: any; } | |
22
+
23
+ **Returns:**
24
+
25
+ boolean
26
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isActorErrorEvent](./foundation-state-machine.isactorerrorevent.md)
4
4
 
5
- ## isActorErrorEvent variable
5
+ ## isActorErrorEvent() function
6
6
 
7
7
  isActorErrorEvent.
8
8
 
@@ -11,3 +11,15 @@ isActorErrorEvent.
11
11
  ```typescript
12
12
  isActorErrorEvent: <TData = any>(actorId: string, event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | actorId | string | An actor id. |
20
+ | event | EventObject \| ErrorEvent&lt;TData&gt; | An event. |
21
+
22
+ **Returns:**
23
+
24
+ event is ErrorEvent&lt;TData&gt;
25
+
@@ -2,10 +2,21 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isAPIError](./foundation-state-machine.isapierror.md)
4
4
 
5
- ## isAPIError variable
5
+ ## isAPIError() function
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
10
  isAPIError: (error: unknown) => error is APIError
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | error | unknown | An error. |
18
+
19
+ **Returns:**
20
+
21
+ error is [APIError](./foundation-state-machine.apierror.md)
22
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isDoneInvokeEvent](./foundation-state-machine.isdoneinvokeevent.md)
4
4
 
5
- ## isDoneInvokeEvent variable
5
+ ## isDoneInvokeEvent() function
6
6
 
7
7
  isDoneInvokeEvent.
8
8
 
@@ -11,3 +11,14 @@ isDoneInvokeEvent.
11
11
  ```typescript
12
12
  isDoneInvokeEvent: <TData = any>(event: EventObject | DoneInvokeEvent<TData>) => event is DoneInvokeEvent<TData>
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | event | EventObject \| DoneInvokeEvent&lt;TData&gt; | An event. |
20
+
21
+ **Returns:**
22
+
23
+ event is DoneInvokeEvent&lt;TData&gt;
24
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md)
4
4
 
5
- ## isErrorCustomEvent variable
5
+ ## isErrorCustomEvent() function
6
6
 
7
7
  isErrorCustomEvent.
8
8
 
@@ -12,6 +12,16 @@ isErrorCustomEvent.
12
12
  isErrorCustomEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | event | EventObject \| ErrorEvent&lt;TData&gt; | An event. |
20
+
21
+ **Returns:**
22
+
23
+ event is ErrorEvent&lt;TData&gt;
24
+
15
25
  ## Remarks
16
26
 
17
27
  What `escalate` from a child is typed as.
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isErrorEvent](./foundation-state-machine.iserrorevent.md)
4
4
 
5
- ## isErrorEvent variable
5
+ ## isErrorEvent() function
6
6
 
7
7
  isErrorEvent.
8
8
 
@@ -11,3 +11,14 @@ isErrorEvent.
11
11
  ```typescript
12
12
  isErrorEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | event | EventObject \| ErrorEvent&lt;TData&gt; | An event. |
20
+
21
+ **Returns:**
22
+
23
+ event is ErrorEvent&lt;TData&gt;
24
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isErrorType](./foundation-state-machine.iserrortype.md)
4
4
 
5
- ## isErrorType variable
5
+ ## isErrorType() function
6
6
 
7
7
  isErrorType.
8
8
 
@@ -11,3 +11,14 @@ isErrorType.
11
11
  ```typescript
12
12
  isErrorType: <TType extends ErrorConstructor>(type: TType) => (event: any) => boolean
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | type | TType | An event type. |
20
+
21
+ **Returns:**
22
+
23
+ (event: any) =&gt; boolean
24
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isEventWithParams](./foundation-state-machine.iseventwithparams.md)
4
4
 
5
- ## isEventWithParams variable
5
+ ## isEventWithParams() function
6
6
 
7
7
  isEventWithParams.
8
8
 
@@ -11,3 +11,14 @@ isEventWithParams.
11
11
  ```typescript
12
12
  isEventWithParams: (event: AnyEventObject) => event is ParameterizedObject
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | event | AnyEventObject | An event. |
20
+
21
+ **Returns:**
22
+
23
+ event is ParameterizedObject
24
+
@@ -2,10 +2,21 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md)
4
4
 
5
- ## isGenesisServerError variable
5
+ ## isGenesisServerError() function
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
10
  isGenesisServerError: (error: unknown) => error is GenesisServerError
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | error | unknown | An error. |
18
+
19
+ **Returns:**
20
+
21
+ error is [GenesisServerError](./foundation-state-machine.genesisservererror.md)
22
+
@@ -2,10 +2,21 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isMappingError](./foundation-state-machine.ismappingerror.md)
4
4
 
5
- ## isMappingError variable
5
+ ## isMappingError() function
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
10
  isMappingError: (error: unknown) => error is MappingError
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | error | unknown | An error. |
18
+
19
+ **Returns:**
20
+
21
+ error is [MappingError](./foundation-state-machine.mappingerror.md)
22
+
@@ -2,10 +2,21 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isNetworkError](./foundation-state-machine.isnetworkerror.md)
4
4
 
5
- ## isNetworkError variable
5
+ ## isNetworkError() function
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
10
  isNetworkError: (error: unknown) => error is NetworkError
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | error | unknown | An error. |
18
+
19
+ **Returns:**
20
+
21
+ error is [NetworkError](./foundation-state-machine.networkerror.md)
22
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isNotFoundError](./foundation-state-machine.isnotfounderror.md)
4
4
 
5
- ## isNotFoundError variable
5
+ ## isNotFoundError() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -11,3 +11,14 @@ isNotFoundError: (error: {
11
11
  status?: number;
12
12
  }) => error is APIError
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | error | { status?: number; } | An error. |
20
+
21
+ **Returns:**
22
+
23
+ error is [APIError](./foundation-state-machine.apierror.md)
24
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isSyntaxError](./foundation-state-machine.issyntaxerror.md)
4
4
 
5
- ## isSyntaxError variable
5
+ ## isSyntaxError() function
6
6
 
7
7
  isSyntaxError.
8
8
 
@@ -13,3 +13,14 @@ isSyntaxError: ({ event }: {
13
13
  event: any;
14
14
  }) => boolean
15
15
  ```
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type | Description |
20
+ | --- | --- | --- |
21
+ | { event } | { event: any; } | |
22
+
23
+ **Returns:**
24
+
25
+ boolean
26
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isTypeError](./foundation-state-machine.istypeerror.md)
4
4
 
5
- ## isTypeError variable
5
+ ## isTypeError() function
6
6
 
7
7
  isTypeError.
8
8
 
@@ -13,3 +13,14 @@ isTypeError: ({ event }: {
13
13
  event: any;
14
14
  }) => boolean
15
15
  ```
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type | Description |
20
+ | --- | --- | --- |
21
+ | { event } | { event: any; } | |
22
+
23
+ **Returns:**
24
+
25
+ boolean
26
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isUnauthorizedError](./foundation-state-machine.isunauthorizederror.md)
4
4
 
5
- ## isUnauthorizedError variable
5
+ ## isUnauthorizedError() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -11,3 +11,14 @@ isUnauthorizedError: (error: {
11
11
  status?: number;
12
12
  }) => error is APIError
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | error | { status?: number; } | An error. |
20
+
21
+ **Returns:**
22
+
23
+ error is [APIError](./foundation-state-machine.apierror.md)
24
+
@@ -25,6 +25,26 @@
25
25
  | Function | Description |
26
26
  | --- | --- |
27
27
  | [assertEvent(event, type)](./foundation-state-machine.assertevent.md) | assertEvent. |
28
+ | [createErrorStateNode(key, metaContent, final)](./foundation-state-machine.createerrorstatenode.md) | Creates an error state node. |
29
+ | [createFetchPolicy(maxAttempts, retryCodes, backoff, timeoutDuration, logEvents)](./foundation-state-machine.createfetchpolicy.md) | A fetch policy factory. |
30
+ | [createResponseDataExtractorWithDeserializer(deserializer, extractor)](./foundation-state-machine.createresponsedataextractorwithdeserializer.md) | Creates an extractor that applies a deserializer to the extracted response data. |
31
+ | [errorWorkflowInput(key)](./foundation-state-machine.errorworkflowinput.md) | Error workflow input. |
32
+ | [isAbortError({ event })](./foundation-state-machine.isaborterror.md) | isAbortError. |
33
+ | [isActorErrorEvent(actorId, event)](./foundation-state-machine.isactorerrorevent.md) | isActorErrorEvent. |
34
+ | [isAPIError(error)](./foundation-state-machine.isapierror.md) | |
35
+ | [isDoneInvokeEvent(event)](./foundation-state-machine.isdoneinvokeevent.md) | isDoneInvokeEvent. |
36
+ | [isErrorCustomEvent(event)](./foundation-state-machine.iserrorcustomevent.md) | isErrorCustomEvent. |
37
+ | [isErrorEvent(event)](./foundation-state-machine.iserrorevent.md) | isErrorEvent. |
38
+ | [isErrorType(type)](./foundation-state-machine.iserrortype.md) | isErrorType. |
39
+ | [isEventWithParams(event)](./foundation-state-machine.iseventwithparams.md) | isEventWithParams. |
40
+ | [isGenesisServerError(error)](./foundation-state-machine.isgenesisservererror.md) | |
41
+ | [isMappingError(error)](./foundation-state-machine.ismappingerror.md) | |
42
+ | [isNetworkError(error)](./foundation-state-machine.isnetworkerror.md) | |
43
+ | [isNotFoundError(error)](./foundation-state-machine.isnotfounderror.md) | |
44
+ | [isSyntaxError({ event })](./foundation-state-machine.issyntaxerror.md) | isSyntaxError. |
45
+ | [isTypeError({ event })](./foundation-state-machine.istypeerror.md) | isTypeError. |
46
+ | [isUnauthorizedError(error)](./foundation-state-machine.isunauthorizederror.md) | |
47
+ | [setErrorByKey(key)](./foundation-state-machine.seterrorbykey.md) | Set error by key action. |
28
48
 
29
49
  ## Interfaces
30
50
 
@@ -40,35 +60,15 @@
40
60
 
41
61
  | Variable | Description |
42
62
  | --- | --- |
43
- | [createErrorStateNode](./foundation-state-machine.createerrorstatenode.md) | Creates an error state node. |
44
- | [createFetchPolicy](./foundation-state-machine.createfetchpolicy.md) | A fetch policy factory. |
45
- | [createResponseDataExtractorWithDeserializer](./foundation-state-machine.createresponsedataextractorwithdeserializer.md) | Creates an extractor that applies a deserializer to the extracted response data. |
46
63
  | [defaultFetchConfig](./foundation-state-machine.defaultfetchconfig.md) | The default fetch config. |
47
64
  | [defaultFetchMachineContext](./foundation-state-machine.defaultfetchmachinecontext.md) | Default FetchMachineContext. |
48
65
  | [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md) | The default fetch policy. |
49
66
  | [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md) | ResponseDataExtractor type. |
50
67
  | [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md) | ResponseOkChecker type. |
51
68
  | [defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md) | Default retry stats codes. |
52
- | [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md) | Error workflow input. |
53
69
  | [escalateError](./foundation-state-machine.escalateerror.md) | Escalate context error action. |
54
- | [isAbortError](./foundation-state-machine.isaborterror.md) | isAbortError. |
55
- | [isActorErrorEvent](./foundation-state-machine.isactorerrorevent.md) | isActorErrorEvent. |
56
- | [isAPIError](./foundation-state-machine.isapierror.md) | |
57
- | [isDoneInvokeEvent](./foundation-state-machine.isdoneinvokeevent.md) | isDoneInvokeEvent. |
58
- | [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md) | isErrorCustomEvent. |
59
- | [isErrorEvent](./foundation-state-machine.iserrorevent.md) | isErrorEvent. |
60
- | [isErrorType](./foundation-state-machine.iserrortype.md) | isErrorType. |
61
- | [isEventWithParams](./foundation-state-machine.iseventwithparams.md) | isEventWithParams. |
62
- | [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md) | |
63
- | [isMappingError](./foundation-state-machine.ismappingerror.md) | |
64
- | [isNetworkError](./foundation-state-machine.isnetworkerror.md) | |
65
- | [isNotFoundError](./foundation-state-machine.isnotfounderror.md) | |
66
- | [isSyntaxError](./foundation-state-machine.issyntaxerror.md) | isSyntaxError. |
67
- | [isTypeError](./foundation-state-machine.istypeerror.md) | isTypeError. |
68
- | [isUnauthorizedError](./foundation-state-machine.isunauthorizederror.md) | |
69
70
  | [logger](./foundation-state-machine.logger.md) | |
70
71
  | [setError](./foundation-state-machine.seterror.md) | Set error action. |
71
- | [setErrorByKey](./foundation-state-machine.seterrorbykey.md) | Set error by key action. |
72
72
 
73
73
  ## Type Aliases
74
74
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [setErrorByKey](./foundation-state-machine.seterrorbykey.md)
4
4
 
5
- ## setErrorByKey variable
5
+ ## setErrorByKey() function
6
6
 
7
7
  Set error by key action.
8
8
 
@@ -19,6 +19,16 @@ setErrorByKey: (key: string) => {
19
19
  }
20
20
  ```
21
21
 
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Description |
25
+ | --- | --- | --- |
26
+ | key | string | The error key. |
27
+
28
+ **Returns:**
29
+
30
+ { (\_: import("xstate").ActionArgs&lt;import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject&gt;): void; type: string; assignment: import("xstate").Assigner&lt;import("xstate").MachineContext, import("xstate").EventObject&gt; \| import("xstate").PropertyAssigner&lt;import("xstate").MachineContext, import("xstate").EventObject&gt;; resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, actionArgs: import("xstate").ActionArgs&lt;any, any, import("xstate").ParameterizedObject&gt;, { assignment }: { assignment: import("xstate").Assigner&lt;any, any&gt; \| import("xstate").PropertyAssigner&lt;any, any&gt;; }) =&gt; import("xstate").AnyState\[\]; }
31
+
22
32
  ## Remarks
23
33
 
24
34
  Used to set an error in the by key.
@@ -33,7 +33,7 @@ import { IRetryContext } from 'cockatiel';
33
33
  import { Logger } from '@genesislcap/foundation-logger';
34
34
  import { MachineContext as MachineContext_2 } from 'xstate';
35
35
  import { Message } from '@genesislcap/foundation-comms';
36
- import type { NoInfer } from 'xstate';
36
+ import type { NoInfer as NoInfer_2 } from 'xstate';
37
37
  import { ParameterizedObject } from 'xstate';
38
38
  import { PropertyAssigner } from 'xstate';
39
39
  import type { ProvidedActor } from 'xstate';
@@ -51,7 +51,7 @@ import type { TypegenDisabled } from 'xstate';
51
51
  import { UnifiedArg } from 'xstate';
52
52
 
53
53
  // @public
54
- export abstract class AbstractMachine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer<TEvent>, TAction, TActor>> implements Machine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta> {
54
+ export abstract class AbstractMachine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer_2<TEvent>, TAction, TActor>> implements Machine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta> {
55
55
  actor: InterpreterFrom<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>;
56
56
  // @internal (undocumented)
57
57
  protected applySnapshot(snapshot?: typeof AbstractMachine.snapshot): void;
@@ -312,7 +312,7 @@ export const isUnauthorizedError: (error: {
312
312
  export const logger: Logger;
313
313
 
314
314
  // @public
315
- export interface Machine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer<TEvent>, TAction, TActor>> {
315
+ export interface Machine<TContext extends MachineContext, TEvent extends EventObject = AnyEventObject, TAction extends ParameterizedObject = ParameterizedObject, TActor extends ProvidedActor = ProvidedActor, TInput = any, TResolvedTypesMeta = ResolveTypegenMeta<TypegenDisabled, NoInfer_2<TEvent>, TAction, TActor>> {
316
316
  readonly actor?: InterpreterFrom<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>;
317
317
  // Warning: (ae-incompatible-release-tags) The symbol "binding" is marked as @public, but its signature references "SubscriberChangeCallback" which is marked as @internal
318
318
  binding<TReturn = any, TParent = any>(token: ((target: this) => TReturn) | keyof this, subscriberChangeCallback?: SubscriberChangeCallback<TReturn> | undefined, isVolatileBinding?: boolean, context?: ExecutionContext): BindingObserver<this, TReturn, TParent>;