@genesislcap/foundation-state-machine 14.70.0

package/docs/api/foundation-state-machine.defaultfetchmachine.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [DefaultFetchMachine](./foundation-state-machine.defaultfetchmachine.md)
+
+## DefaultFetchMachine class
+
+Default FetchMachine.
+
+**Signature:**
+
+```typescript
+export declare class DefaultFetchMachine extends AbstractMachine<FetchMachineContext, FetchMachineEvent> implements FetchMachine 
+```
+**Extends:** [AbstractMachine](./foundation-state-machine.abstractmachine.md)<!-- -->&lt;[FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)<!-- -->, [FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md)<!-- -->&gt;
+
+**Implements:** [FetchMachine](./foundation-state-machine.fetchmachine.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(config)](./foundation-state-machine.defaultfetchmachine._constructor_.md) |  | Constructs a new instance of the <code>DefaultFetchMachine</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getFromContainer()](./foundation-state-machine.defaultfetchmachine.getfromcontainer.md) |  | Gets the machine from the container. |
+|  [start(options)](./foundation-state-machine.defaultfetchmachine.start.md) |  | Start the machine. |
+

package/docs/api/foundation-state-machine.defaultfetchmachine.start.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [DefaultFetchMachine](./foundation-state-machine.defaultfetchmachine.md) &gt; [start](./foundation-state-machine.defaultfetchmachine.start.md)
+
+## DefaultFetchMachine.start() method
+
+Start the machine.
+
+**Signature:**
+
+```typescript
+start(options?: InterpreterOptions<typeof this.machine>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | InterpreterOptions&lt;typeof [this.machine](./foundation-state-machine.abstractmachine.machine.md)<!-- -->&gt; | _(Optional)_ Optional InterpreterOptions. Can be used to restore to a previously persisted state. |
+
+**Returns:**
+
+void
+
+## Remarks
+
+Called to ready the machine and create the internal actor (interpreter). This is called internally after `createMachine` by convention, however it should also be called after calling [provide](./foundation-state-machine.machine.provide.md) when overriding logic. Calling `start` on an injected machine allows you to restart/reuse it if needed. This is okay for machines registered as `transient` in the DI, but care should be taken when creating a machine registered as a `singleton`<!-- -->. You may need to check the status of the machine and block re-starts.
+

package/docs/api/foundation-state-machine.defaultfetchmachinecontext.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [defaultFetchMachineContext](./foundation-state-machine.defaultfetchmachinecontext.md)
+
+## defaultFetchMachineContext variable
+
+Default FetchMachineContext.
+
+**Signature:**
+
+```typescript
+defaultFetchMachineContext: Partial<FetchMachineContext>
+```

package/docs/api/foundation-state-machine.defaultfetchpolicy.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md)
+
+## defaultFetchPolicy variable
+
+The default fetch policy.
+
+**Signature:**
+
+```typescript
+defaultFetchPolicy: import("cockatiel").IMergedPolicy<import("cockatiel").IRetryContext & import("cockatiel").ICancellationContext, never, [import("cockatiel").RetryPolicy, import("cockatiel").TimeoutPolicy]>
+```

package/docs/api/foundation-state-machine.defaultresponsedataextractor.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md)
+
+## defaultResponseDataExtractor variable
+
+ResponseDataExtractor type.
+
+**Signature:**
+
+```typescript
+defaultResponseDataExtractor: ResponseDataExtractor
+```
+
+## Remarks
+
+Extracts data from the  and processes it accordingly. The default data extractor will inspect `content-type` and call `JSON.parse()` if it includes `application/json`<!-- -->. Custom data extractors can be used here.
+

package/docs/api/foundation-state-machine.defaultresponseokchecker.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md)
+
+## defaultResponseOkChecker variable
+
+ResponseOkChecker type.
+
+**Signature:**
+
+```typescript
+defaultResponseOkChecker: ResponseOkChecker
+```

package/docs/api/foundation-state-machine.defaultretrystatscodes.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md)
+
+## defaultRetryStatsCodes variable
+
+Default retry stats codes.
+
+**Signature:**
+
+```typescript
+defaultRetryStatsCodes: StatusCodes[]
+```

package/docs/api/foundation-state-machine.errorworkflowinput.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md)
+
+## errorWorkflowInput variable
+
+Error workflow input.
+
+**Signature:**
+
+```typescript
+errorWorkflowInput: (key: string) => ({ context }: {
+    context: any;
+}) => ErrorWorkflowInput
+```

package/docs/api/foundation-state-machine.escalateerror.md

@@ -0,0 +1,42 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [escalateError](./foundation-state-machine.escalateerror.md)
+
+## escalateError variable
+
+Escalate error action.
+
+**Signature:**
+
+```typescript
+escalateError: {
+    (_: import("xstate").ActionArgs<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject>): void;
+    type: string;
+    to: string | import("xstate").AnyActorRef | ((args: import("xstate").UnifiedArg<import("xstate").MachineContext, import("xstate").EventObject>) => string | import("xstate").AnyActorRef);
+    event: any;
+    id: string;
+    delay: string | number | import("xstate").DelayExpr<import("xstate").MachineContext, import("xstate").EventObject>;
+    resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, args: import("xstate").ActionArgs<any, any, import("xstate").ParameterizedObject>, { to, event: eventOrExpr, id, delay }: {
+        to: string | import("xstate").AnyActorRef | ((args: import("xstate").UnifiedArg<import("xstate").MachineContext, import("xstate").EventObject>) => string | import("xstate").AnyActorRef);
+        event: import("xstate").EventObject | import("xstate").SendExpr<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").EventObject>;
+        id: string;
+        delay: string | number | import("xstate").DelayExpr<import("xstate").MachineContext, import("xstate").EventObject>;
+    }) => (import("xstate").AnyState | {
+        to: import("xstate").AnyActorRef;
+        event: import("xstate").EventObject;
+        id: string;
+        delay: number;
+    })[];
+    execute: (actorContext: import("xstate").AnyActorContext, params: {
+        to: import("xstate").AnyActorRef;
+        event: import("xstate").EventObject;
+        id: string;
+        delay: number;
+    }) => void;
+}
+```
+
+## Remarks
+
+Guard this call with a parent check to avoid warnings when there's no parent.
+

package/docs/api/foundation-state-machine.fetchconfig.fetcher.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchConfig](./foundation-state-machine.fetchconfig.md) &gt; [fetcher](./foundation-state-machine.fetchconfig.fetcher.md)
+
+## FetchConfig.fetcher property
+
+Defaults to .
+
+**Signature:**
+
+```typescript
+fetcher: typeof fetch;
+```

package/docs/api/foundation-state-machine.fetchconfig.fetchpolicy.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchConfig](./foundation-state-machine.fetchconfig.md) &gt; [fetchPolicy](./foundation-state-machine.fetchconfig.fetchpolicy.md)
+
+## FetchConfig.fetchPolicy property
+
+Defaults to [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md)
+
+**Signature:**
+
+```typescript
+fetchPolicy?: IMergedPolicy<any, any, any>;
+```

package/docs/api/foundation-state-machine.fetchconfig.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchConfig](./foundation-state-machine.fetchconfig.md)
+
+## FetchConfig interface
+
+FetchConfig interface.
+
+**Signature:**
+
+```typescript
+export interface FetchConfig 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [fetcher](./foundation-state-machine.fetchconfig.fetcher.md) |  | typeof fetch | Defaults to . |
+|  [fetchPolicy?](./foundation-state-machine.fetchconfig.fetchpolicy.md) |  | IMergedPolicy&lt;any, any, any&gt; | _(Optional)_ Defaults to [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md) |
+|  [responseDataExtractor?](./foundation-state-machine.fetchconfig.responsedataextractor.md) |  | [ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md) | _(Optional)_ Defaults to [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md) |
+|  [responseOkChecker?](./foundation-state-machine.fetchconfig.responseokchecker.md) |  | [ResponseOkChecker](./foundation-state-machine.responseokchecker.md) | _(Optional)_ Defaults to [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md) |
+

package/docs/api/foundation-state-machine.fetchconfig.responsedataextractor.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchConfig](./foundation-state-machine.fetchconfig.md) &gt; [responseDataExtractor](./foundation-state-machine.fetchconfig.responsedataextractor.md)
+
+## FetchConfig.responseDataExtractor property
+
+Defaults to [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md)
+
+**Signature:**
+
+```typescript
+responseDataExtractor?: ResponseDataExtractor;
+```

package/docs/api/foundation-state-machine.fetchconfig.responseokchecker.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchConfig](./foundation-state-machine.fetchconfig.md) &gt; [responseOkChecker](./foundation-state-machine.fetchconfig.responseokchecker.md)
+
+## FetchConfig.responseOkChecker property
+
+Defaults to [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md)
+
+**Signature:**
+
+```typescript
+responseOkChecker?: ResponseOkChecker;
+```

package/docs/api/foundation-state-machine.fetchmachine.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachine](./foundation-state-machine.fetchmachine.md)
+
+## FetchMachine interface
+
+FetchMachine interface.
+
+**Signature:**
+
+```typescript
+export interface FetchMachine extends Machine<FetchMachineContext, FetchMachineEvent> 
+```
+**Extends:** [Machine](./foundation-state-machine.machine.md)<!-- -->&lt;[FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)<!-- -->, [FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md)<!-- -->&gt;
+

package/docs/api/foundation-state-machine.fetchmachinecontext.controller.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md) &gt; [controller](./foundation-state-machine.fetchmachinecontext.controller.md)
+
+## FetchMachineContext.controller property
+
+The abort controller of the fetch request.
+
+**Signature:**
+
+```typescript
+controller: AbortController;
+```

package/docs/api/foundation-state-machine.fetchmachinecontext.data.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md) &gt; [data](./foundation-state-machine.fetchmachinecontext.data.md)
+
+## FetchMachineContext.data property
+
+The extracted response data.
+
+**Signature:**
+
+```typescript
+data: any;
+```

package/docs/api/foundation-state-machine.fetchmachinecontext.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)
+
+## FetchMachineContext interface
+
+FetchMachineContext interface.
+
+**Signature:**
+
+```typescript
+export interface FetchMachineContext extends MachineContext 
+```
+**Extends:** [MachineContext](./foundation-state-machine.machinecontext.md)
+
+## Remarks
+
+Transient state during the machine's execution.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [controller](./foundation-state-machine.fetchmachinecontext.controller.md) |  | AbortController | The abort controller of the fetch request. |
+|  [data](./foundation-state-machine.fetchmachinecontext.data.md) |  | any | The extracted response data. |
+|  [params](./foundation-state-machine.fetchmachinecontext.params.md) |  | { url: string; requestInit?: RequestInit \| CMRequestInit; fetchConfig?: [FetchConfig](./foundation-state-machine.fetchconfig.md)<!-- -->; } | The params of the fetch request. |
+|  [response](./foundation-state-machine.fetchmachinecontext.response.md) |  | Response \| undefined | The fetch response. |
+

package/docs/api/foundation-state-machine.fetchmachinecontext.params.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md) &gt; [params](./foundation-state-machine.fetchmachinecontext.params.md)
+
+## FetchMachineContext.params property
+
+The params of the fetch request.
+
+**Signature:**
+
+```typescript
+params: {
+        url: string;
+        requestInit?: RequestInit | CMRequestInit;
+        fetchConfig?: FetchConfig;
+    };
+```

package/docs/api/foundation-state-machine.fetchmachinecontext.response.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md) &gt; [response](./foundation-state-machine.fetchmachinecontext.response.md)
+
+## FetchMachineContext.response property
+
+The fetch response.
+
+**Signature:**
+
+```typescript
+response: Response | undefined;
+```

package/docs/api/foundation-state-machine.fetchmachineevent.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md)
+
+## FetchMachineEvent type
+
+FetchMachineEvent type.
+
+**Signature:**
+
+```typescript
+export type FetchMachineEvent = {
+    type: 'fetch';
+    params: FetchMachineContext['params'];
+} | {
+    type: 'cancel';
+} | DoneInvokeEvent<unknown> | ErrorEvent<unknown>;
+```
+**References:** [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)
+
+## Remarks
+
+The send action events used to invoke the machine.
+

package/docs/api/foundation-state-machine.fetchmachineeventmap.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineEventMap](./foundation-state-machine.fetchmachineeventmap.md)
+
+## FetchMachineEventMap type
+
+FetchMachineEventMap type.
+
+**Signature:**
+
+```typescript
+export type FetchMachineEventMap = {
+    'fetch-machine-event': FetchMachineEvent;
+};
+```
+**References:** [FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md)
+
+## Remarks
+
+The mediation CustomEvent used to invoke machine actions.
+

package/docs/api/foundation-state-machine.fetchmachineoutput.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [FetchMachineOutput](./foundation-state-machine.fetchmachineoutput.md)
+
+## FetchMachineOutput type
+
+FetchMachineOutput type.
+
+**Signature:**
+
+```typescript
+export type FetchMachineOutput<TData = any> = Partial<Pick<FetchMachineContext, 'response' | 'error'>> & {
+    data: TData;
+};
+```
+**References:** [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)
+
+## Remarks
+
+The output of the machine when it reaches it's final state, which is provided to host machines via handlers.
+

package/docs/api/foundation-state-machine.genesisservererror._constructor_.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [(constructor)](./foundation-state-machine.genesisservererror._constructor_.md)
+
+## GenesisServerError.(constructor)
+
+Constructs a new instance of the `GenesisServerError` class
+
+**Signature:**
+
+```typescript
+constructor(sent?: Message, received?: Message, message?: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sent | Message | _(Optional)_ |
+|  received | Message | _(Optional)_ |
+|  message | string | _(Optional)_ |
+

package/docs/api/foundation-state-machine.genesisservererror.getdetailserror.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [getDetailsError](./foundation-state-machine.genesisservererror.getdetailserror.md)
+
+## GenesisServerError.getDetailsError() method
+
+**Signature:**
+
+```typescript
+getDetailsError(): string;
+```
+**Returns:**
+
+string
+

package/docs/api/foundation-state-machine.genesisservererror.getmessageerror.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [getMessageError](./foundation-state-machine.genesisservererror.getmessageerror.md)
+
+## GenesisServerError.getMessageError() method
+
+**Signature:**
+
+```typescript
+getMessageError(): string;
+```
+**Returns:**
+
+string
+

package/docs/api/foundation-state-machine.genesisservererror.haserrorcode.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [hasErrorCode](./foundation-state-machine.genesisservererror.haserrorcode.md)
+
+## GenesisServerError.hasErrorCode() method
+
+**Signature:**
+
+```typescript
+hasErrorCode(code: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  code | string |  |
+
+**Returns:**
+
+boolean
+

package/docs/api/foundation-state-machine.genesisservererror.isignorableerror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [isIgnorableError](./foundation-state-machine.genesisservererror.isignorableerror.md)
+
+## GenesisServerError.isIgnorableError() method
+
+Capture known edge cases.
+
+**Signature:**
+
+```typescript
+isIgnorableError(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/api/foundation-state-machine.genesisservererror.md

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md)
+
+## GenesisServerError class
+
+GenesisServerError.
+
+**Signature:**
+
+```typescript
+export declare class GenesisServerError extends Error 
+```
+**Extends:** Error
+
+## Remarks
+
+Represents an error received from a Genesis Server.
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(sent, received, message)](./foundation-state-machine.genesisservererror._constructor_.md) |  | Constructs a new instance of the <code>GenesisServerError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [received?](./foundation-state-machine.genesisservererror.received.md) |  | Message | _(Optional)_ |
+|  [sent?](./foundation-state-machine.genesisservererror.sent.md) |  | Message | _(Optional)_ |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getDetailsError()](./foundation-state-machine.genesisservererror.getdetailserror.md) |  |  |
+|  [getMessageError()](./foundation-state-machine.genesisservererror.getmessageerror.md) |  |  |
+|  [hasErrorCode(code)](./foundation-state-machine.genesisservererror.haserrorcode.md) |  |  |
+|  [isIgnorableError()](./foundation-state-machine.genesisservererror.isignorableerror.md) |  | Capture known edge cases. |
+

package/docs/api/foundation-state-machine.genesisservererror.received.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [received](./foundation-state-machine.genesisservererror.received.md)
+
+## GenesisServerError.received property
+
+**Signature:**
+
+```typescript
+received?: Message;
+```

package/docs/api/foundation-state-machine.genesisservererror.sent.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [GenesisServerError](./foundation-state-machine.genesisservererror.md) &gt; [sent](./foundation-state-machine.genesisservererror.sent.md)
+
+## GenesisServerError.sent property
+
+**Signature:**
+
+```typescript
+sent?: Message;
+```

package/docs/api/foundation-state-machine.isaborterror.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [isAbortError](./foundation-state-machine.isaborterror.md)
+
+## isAbortError variable
+
+isAbortError.
+
+**Signature:**
+
+```typescript
+isAbortError: ({ event }: {
+    event: any;
+}) => boolean
+```