@genesislcap/foundation-state-machine 14.226.0 → 14.226.2-alpha-bcda968.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dts/core/binding.d.ts.map +1 -1
- package/dist/dts/core/guards.d.ts.map +1 -1
- package/dist/dts/machines/fetch/types.d.ts.map +1 -1
- package/dist/{tsdoc-metadata.json → dts/tsdoc-metadata.json} +1 -1
- package/dist/esm/machines/fetch/machine.js +6 -6
- package/dist/foundation-state-machine.api.json +239 -772
- package/dist/foundation-state-machine.d.ts +3 -3
- package/docs/api/foundation-state-machine.createerrorstatenode.md +1 -14
- package/docs/api/foundation-state-machine.createfetchpolicy.md +1 -15
- package/docs/api/foundation-state-machine.createresponsedataextractorwithdeserializer.md +1 -13
- package/docs/api/foundation-state-machine.errorworkflowinput.md +6 -8
- package/docs/api/foundation-state-machine.isaborterror.md +1 -12
- package/docs/api/foundation-state-machine.isactorerrorevent.md +1 -13
- package/docs/api/foundation-state-machine.isapierror.md +1 -12
- package/docs/api/foundation-state-machine.isdoneinvokeevent.md +1 -12
- package/docs/api/foundation-state-machine.iserrorcustomevent.md +1 -11
- package/docs/api/foundation-state-machine.iserrorevent.md +1 -12
- package/docs/api/foundation-state-machine.iserrortype.md +1 -12
- package/docs/api/foundation-state-machine.iseventwithparams.md +1 -12
- package/docs/api/foundation-state-machine.isgenesisservererror.md +1 -12
- package/docs/api/foundation-state-machine.ismappingerror.md +1 -12
- package/docs/api/foundation-state-machine.isnetworkerror.md +1 -12
- package/docs/api/foundation-state-machine.isnotfounderror.md +1 -12
- package/docs/api/foundation-state-machine.issyntaxerror.md +1 -12
- package/docs/api/foundation-state-machine.istypeerror.md +1 -12
- package/docs/api/foundation-state-machine.isunauthorizederror.md +1 -12
- package/docs/api/foundation-state-machine.md +20 -20
- package/docs/api/foundation-state-machine.seterrorbykey.md +1 -11
- package/docs/{api-report.md.api.md → api-report.md} +3 -3
- 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
|
|
30
|
+
import type { NoInfer } 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,
|
|
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> {
|
|
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,
|
|
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>> {
|
|
600
600
|
/**
|
|
601
601
|
* Mandatory machine property.
|
|
602
602
|
* @remarks
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [createErrorStateNode](./foundation-state-machine.createerrorstatenode.md)
|
|
4
4
|
|
|
5
|
-
## createErrorStateNode
|
|
5
|
+
## createErrorStateNode variable
|
|
6
6
|
|
|
7
7
|
Creates an error state node.
|
|
8
8
|
|
|
@@ -11,16 +11,3 @@ 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<any, any, any, any>
|
|
26
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [createFetchPolicy](./foundation-state-machine.createfetchpolicy.md)
|
|
4
4
|
|
|
5
|
-
## createFetchPolicy
|
|
5
|
+
## createFetchPolicy variable
|
|
6
6
|
|
|
7
7
|
A fetch policy factory.
|
|
8
8
|
|
|
@@ -12,20 +12,6 @@ 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<IRetryBackoffContext<unknown>> | _(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<import("cockatiel").IRetryContext & import("cockatiel").ICancellationContext, never, \[import("cockatiel").RetryPolicy, import("cockatiel").TimeoutPolicy\]>
|
|
28
|
-
|
|
29
15
|
## Remarks
|
|
30
16
|
|
|
31
17
|
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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [createResponseDataExtractorWithDeserializer](./foundation-state-machine.createresponsedataextractorwithdeserializer.md)
|
|
4
4
|
|
|
5
|
-
## createResponseDataExtractorWithDeserializer
|
|
5
|
+
## createResponseDataExtractorWithDeserializer variable
|
|
6
6
|
|
|
7
7
|
Creates an extractor that applies a deserializer to the extracted response data.
|
|
8
8
|
|
|
@@ -11,15 +11,3 @@ 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) => Promise<TOutput> | 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,17 +1,15 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## errorWorkflowInput variable
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Error workflow input.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
errorMap: ErrorMap<ErrorDetailMap>;
|
|
16
|
-
};
|
|
12
|
+
errorWorkflowInput: (key: string) => ({ context }: {
|
|
13
|
+
context: any;
|
|
14
|
+
}) => ErrorWorkflowInput
|
|
17
15
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isAbortError](./foundation-state-machine.isaborterror.md)
|
|
4
4
|
|
|
5
|
-
## isAbortError
|
|
5
|
+
## isAbortError variable
|
|
6
6
|
|
|
7
7
|
isAbortError.
|
|
8
8
|
|
|
@@ -13,14 +13,3 @@ 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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isActorErrorEvent](./foundation-state-machine.isactorerrorevent.md)
|
|
4
4
|
|
|
5
|
-
## isActorErrorEvent
|
|
5
|
+
## isActorErrorEvent variable
|
|
6
6
|
|
|
7
7
|
isActorErrorEvent.
|
|
8
8
|
|
|
@@ -11,15 +11,3 @@ 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<TData> | An event. |
|
|
21
|
-
|
|
22
|
-
**Returns:**
|
|
23
|
-
|
|
24
|
-
event is ErrorEvent<TData>
|
|
25
|
-
|
|
@@ -2,21 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isAPIError](./foundation-state-machine.isapierror.md)
|
|
4
4
|
|
|
5
|
-
## isAPIError
|
|
5
|
+
## isAPIError variable
|
|
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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isDoneInvokeEvent](./foundation-state-machine.isdoneinvokeevent.md)
|
|
4
4
|
|
|
5
|
-
## isDoneInvokeEvent
|
|
5
|
+
## isDoneInvokeEvent variable
|
|
6
6
|
|
|
7
7
|
isDoneInvokeEvent.
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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<TData> | An event. |
|
|
20
|
-
|
|
21
|
-
**Returns:**
|
|
22
|
-
|
|
23
|
-
event is DoneInvokeEvent<TData>
|
|
24
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md)
|
|
4
4
|
|
|
5
|
-
## isErrorCustomEvent
|
|
5
|
+
## isErrorCustomEvent variable
|
|
6
6
|
|
|
7
7
|
isErrorCustomEvent.
|
|
8
8
|
|
|
@@ -12,16 +12,6 @@ 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<TData> | An event. |
|
|
20
|
-
|
|
21
|
-
**Returns:**
|
|
22
|
-
|
|
23
|
-
event is ErrorEvent<TData>
|
|
24
|
-
|
|
25
15
|
## Remarks
|
|
26
16
|
|
|
27
17
|
What `escalate` from a child is typed as.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isErrorEvent](./foundation-state-machine.iserrorevent.md)
|
|
4
4
|
|
|
5
|
-
## isErrorEvent
|
|
5
|
+
## isErrorEvent variable
|
|
6
6
|
|
|
7
7
|
isErrorEvent.
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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<TData> | An event. |
|
|
20
|
-
|
|
21
|
-
**Returns:**
|
|
22
|
-
|
|
23
|
-
event is ErrorEvent<TData>
|
|
24
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isErrorType](./foundation-state-machine.iserrortype.md)
|
|
4
4
|
|
|
5
|
-
## isErrorType
|
|
5
|
+
## isErrorType variable
|
|
6
6
|
|
|
7
7
|
isErrorType.
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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) => boolean
|
|
24
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isEventWithParams](./foundation-state-machine.iseventwithparams.md)
|
|
4
4
|
|
|
5
|
-
## isEventWithParams
|
|
5
|
+
## isEventWithParams variable
|
|
6
6
|
|
|
7
7
|
isEventWithParams.
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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,21 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md)
|
|
4
4
|
|
|
5
|
-
## isGenesisServerError
|
|
5
|
+
## isGenesisServerError variable
|
|
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,21 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isMappingError](./foundation-state-machine.ismappingerror.md)
|
|
4
4
|
|
|
5
|
-
## isMappingError
|
|
5
|
+
## isMappingError variable
|
|
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,21 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isNetworkError](./foundation-state-machine.isnetworkerror.md)
|
|
4
4
|
|
|
5
|
-
## isNetworkError
|
|
5
|
+
## isNetworkError variable
|
|
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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isNotFoundError](./foundation-state-machine.isnotfounderror.md)
|
|
4
4
|
|
|
5
|
-
## isNotFoundError
|
|
5
|
+
## isNotFoundError variable
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isSyntaxError](./foundation-state-machine.issyntaxerror.md)
|
|
4
4
|
|
|
5
|
-
## isSyntaxError
|
|
5
|
+
## isSyntaxError variable
|
|
6
6
|
|
|
7
7
|
isSyntaxError.
|
|
8
8
|
|
|
@@ -13,14 +13,3 @@ 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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isTypeError](./foundation-state-machine.istypeerror.md)
|
|
4
4
|
|
|
5
|
-
## isTypeError
|
|
5
|
+
## isTypeError variable
|
|
6
6
|
|
|
7
7
|
isTypeError.
|
|
8
8
|
|
|
@@ -13,14 +13,3 @@ 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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [isUnauthorizedError](./foundation-state-machine.isunauthorizederror.md)
|
|
4
4
|
|
|
5
|
-
## isUnauthorizedError
|
|
5
|
+
## isUnauthorizedError variable
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
@@ -11,14 +11,3 @@ 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,26 +25,6 @@
|
|
|
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. |
|
|
48
28
|
|
|
49
29
|
## Interfaces
|
|
50
30
|
|
|
@@ -60,15 +40,35 @@
|
|
|
60
40
|
|
|
61
41
|
| Variable | Description |
|
|
62
42
|
| --- | --- |
|
|
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. |
|
|
63
46
|
| [defaultFetchConfig](./foundation-state-machine.defaultfetchconfig.md) | The default fetch config. |
|
|
64
47
|
| [defaultFetchMachineContext](./foundation-state-machine.defaultfetchmachinecontext.md) | Default FetchMachineContext. |
|
|
65
48
|
| [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md) | The default fetch policy. |
|
|
66
49
|
| [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md) | ResponseDataExtractor type. |
|
|
67
50
|
| [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md) | ResponseOkChecker type. |
|
|
68
51
|
| [defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md) | Default retry stats codes. |
|
|
52
|
+
| [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md) | Error workflow input. |
|
|
69
53
|
| [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) | |
|
|
70
69
|
| [logger](./foundation-state-machine.logger.md) | |
|
|
71
70
|
| [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) > [@genesislcap/foundation-state-machine](./foundation-state-machine.md) > [setErrorByKey](./foundation-state-machine.seterrorbykey.md)
|
|
4
4
|
|
|
5
|
-
## setErrorByKey
|
|
5
|
+
## setErrorByKey variable
|
|
6
6
|
|
|
7
7
|
Set error by key action.
|
|
8
8
|
|
|
@@ -19,16 +19,6 @@ 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<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject>): void; type: string; assignment: import("xstate").Assigner<import("xstate").MachineContext, import("xstate").EventObject> \| import("xstate").PropertyAssigner<import("xstate").MachineContext, import("xstate").EventObject>; resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, actionArgs: import("xstate").ActionArgs<any, any, import("xstate").ParameterizedObject>, { assignment }: { assignment: import("xstate").Assigner<any, any> \| import("xstate").PropertyAssigner<any, any>; }) => import("xstate").AnyState\[\]; }
|
|
31
|
-
|
|
32
22
|
## Remarks
|
|
33
23
|
|
|
34
24
|
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
|
|
36
|
+
import type { NoInfer } 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,
|
|
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> {
|
|
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,
|
|
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>> {
|
|
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>;
|