@genesislcap/foundation-state-machine 14.70.0

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

package/docs/api/foundation-state-machine.abstractmachine.actor.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [actor](./foundation-state-machine.abstractmachine.actor.md)
+
+## AbstractMachine.actor property
+
+Optional actor
+
+**Signature:**
+
+```typescript
+actor: InterpreterFrom<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>;
+```
+
+## Remarks
+
+Callers can decide to reuse/reference if set or create their own.
+

package/docs/api/foundation-state-machine.abstractmachine.binding.md

@@ -0,0 +1,27 @@
+<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [binding](./foundation-state-machine.abstractmachine.binding.md)
+
+## AbstractMachine.binding() method
+
+An api to allow the observation of values and arbitrary bindings outside the template engine.
+
+**Signature:**
+
+```typescript
+binding<TReturn = any, TParent = any>(token: ((target: this) => TReturn) | keyof this, subscriberChangeCallback?: SubscriberChangeCallback<TReturn> | undefined, isVolatileBinding?: boolean, context?: ExecutionContext): BindingObserver<this, TReturn, TParent>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | ((target: this) =&gt; TReturn) \| keyof this | A target lookup token which can take various forms. |
+|  subscriberChangeCallback | SubscriberChangeCallback&lt;TReturn&gt; \| undefined | _(Optional)_ . |
+|  isVolatileBinding | boolean | _(Optional)_ Indicates the binding is volatile. |
+|  context | ExecutionContext | _(Optional)_ . |
+
+**Returns:**
+
+BindingObserver&lt;this, TReturn, TParent&gt;
+

package/docs/api/foundation-state-machine.abstractmachine.complete.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [complete](./foundation-state-machine.abstractmachine.complete.md)
+
+## AbstractMachine.complete property
+
+Indicates if the machine has completed the happy path.
+
+**Signature:**
+
+```typescript
+complete: boolean;
+```

package/docs/api/foundation-state-machine.abstractmachine.context.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [context](./foundation-state-machine.abstractmachine.context.md)
+
+## AbstractMachine.context property
+
+The current `context` of the machine. The data points in context may be considered transient in nature.
+
+**Signature:**
+
+```typescript
+context: Partial<TContext>;
+```

package/docs/api/foundation-state-machine.abstractmachine.error.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [error](./foundation-state-machine.abstractmachine.error.md)
+
+## AbstractMachine.error property
+
+A general machine error. Likely equal to `errors.lastError`<!-- -->.
+
+**Signature:**
+
+```typescript
+error: any;
+```

package/docs/api/foundation-state-machine.abstractmachine.errors.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [errors](./foundation-state-machine.abstractmachine.errors.md)
+
+## AbstractMachine.errors property
+
+An  of errors that may have occurred during the machine's workflows.
+
+**Signature:**
+
+```typescript
+errors: ErrorMap<ErrorDetailMap>;
+```

package/docs/api/foundation-state-machine.abstractmachine.getfromcontainer.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [getFromContainer](./foundation-state-machine.abstractmachine.getfromcontainer.md)
+
+## AbstractMachine.getFromContainer() method
+
+Gets the machine from the container.
+
+**Signature:**
+
+```typescript
+abstract getFromContainer(): this;
+```
+**Returns:**
+
+this
+
+## Remarks
+
+Calling `getFromContainer` on an injected machine will return a new instance providing it was registered with the DI as `transient`<!-- -->. This is simply a convenience method, and may be useful as some machines contain 'final' states, meaning once they complete they can no longer receive events. However, if you want to continue to work with your injected machine reference, re-calling [start](./foundation-state-machine.machine.start.md) may also be a viable option.
+
+Please note that machines are injected into other machines to form parts of complex workflows. In such cases, the parent machine will `invoke` or `spawn` the injected machine's `logic` directly to always create a new actor.
+

package/docs/api/foundation-state-machine.abstractmachine.hastag.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [hasTag](./foundation-state-machine.abstractmachine.hastag.md)
+
+## AbstractMachine.hasTag() method
+
+Check `tags` contain provided tag.
+
+**Signature:**
+
+```typescript
+hasTag(tag: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tag | string | A tag. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This differs from `matches`<!-- -->, as multiple states may use common tags such as `pending` to indicate some async work is occurring. As with `matches`<!-- -->, `hasTag` can be useful if you need to conditionally run logic or render markup.
+

package/docs/api/foundation-state-machine.abstractmachine.machine.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [machine](./foundation-state-machine.abstractmachine.machine.md)
+
+## AbstractMachine.machine property
+
+Mandatory machine property.
+
+**Signature:**
+
+```typescript
+machine: StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>;
+```
+
+## Remarks
+
+The logic / config that goes into a machine is not accessible from the outside, and is owned by the implementing class. However, consumers of that may provide custom `implementations` in the xstate sense via the `provide()` api.
+

package/docs/api/foundation-state-machine.abstractmachine.matches.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [matches](./foundation-state-machine.abstractmachine.matches.md)
+
+## AbstractMachine.matches() method
+
+Check `state` matches provided value.
+
+**Signature:**
+
+```typescript
+matches(value: StateValueFrom<typeof this.machine>): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | StateValueFrom&lt;typeof [this.machine](./foundation-state-machine.abstractmachine.machine.md)<!-- -->&gt; | A state value. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+Can be useful if you need to conditionally run logic or render markup.
+

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

@@ -0,0 +1,44 @@
+<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md)
+
+## AbstractMachine class
+
+AbstractMachine base class.
+
+**Signature:**
+
+```typescript
+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> 
+```
+**Implements:** [Machine](./foundation-state-machine.machine.md)<!-- -->&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [actor](./foundation-state-machine.abstractmachine.actor.md) |  | InterpreterFrom&lt;StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;&gt; | Optional actor |
+|  [complete](./foundation-state-machine.abstractmachine.complete.md) |  | boolean | Indicates if the machine has completed the happy path. |
+|  [context](./foundation-state-machine.abstractmachine.context.md) |  | Partial&lt;TContext&gt; | The current <code>context</code> of the machine. The data points in context may be considered transient in nature. |
+|  [error](./foundation-state-machine.abstractmachine.error.md) |  | any | A general machine error. Likely equal to <code>errors.lastError</code>. |
+|  [errors](./foundation-state-machine.abstractmachine.errors.md) |  | ErrorMap&lt;ErrorDetailMap&gt; | An  of errors that may have occurred during the machine's workflows. |
+|  [machine](./foundation-state-machine.abstractmachine.machine.md) |  | StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt; | Mandatory machine property. |
+|  [onSendEvent](./foundation-state-machine.abstractmachine.onsendevent.md) |  | (event: CustomEvent&lt;TEvent&gt;) =&gt; void | A custom event handler to send events to the machine. |
+|  [output](./foundation-state-machine.abstractmachine.output.md) |  | any | Holds successful machine output if any. |
+|  [startingContext](./foundation-state-machine.abstractmachine.startingcontext.md) |  | Partial&lt;TContext&gt; | The <code>context</code> of the machine when started. |
+|  [startingState](./foundation-state-machine.abstractmachine.startingstate.md) |  | StateValue | The <code>state</code> of the machine when started. Allows consumers to start a machine from a persisted state. |
+|  [state](./foundation-state-machine.abstractmachine.state.md) |  | StateValue | The current <code>state</code> of the machine itself. This is not to be confused with state in the data or store sense. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [binding(token, subscriberChangeCallback, isVolatileBinding, context)](./foundation-state-machine.abstractmachine.binding.md) |  | An api to allow the observation of values and arbitrary bindings outside the template engine. |
+|  [getFromContainer()](./foundation-state-machine.abstractmachine.getfromcontainer.md) | <code>abstract</code> | Gets the machine from the container. |
+|  [hasTag(tag)](./foundation-state-machine.abstractmachine.hastag.md) |  | Check <code>tags</code> contain provided tag. |
+|  [matches(value)](./foundation-state-machine.abstractmachine.matches.md) |  | Check <code>state</code> matches provided value. |
+|  [provide(implementations)](./foundation-state-machine.abstractmachine.provide.md) |  | Recreate the internal machine with the provided implementations. |
+|  [send(event)](./foundation-state-machine.abstractmachine.send.md) |  | An api to send events to the machine. |
+|  [start(options)](./foundation-state-machine.abstractmachine.start.md) |  | Start the machine. |
+|  [stop()](./foundation-state-machine.abstractmachine.stop.md) |  | Stop the machine. |
+

package/docs/api/foundation-state-machine.abstractmachine.onsendevent.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [onSendEvent](./foundation-state-machine.abstractmachine.onsendevent.md)
+
+## AbstractMachine.onSendEvent property
+
+A custom event handler to send events to the machine.
+
+**Signature:**
+
+```typescript
+onSendEvent: (event: CustomEvent<TEvent>) => void;
+```

package/docs/api/foundation-state-machine.abstractmachine.output.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [output](./foundation-state-machine.abstractmachine.output.md)
+
+## AbstractMachine.output property
+
+Holds successful machine output if any.
+
+**Signature:**
+
+```typescript
+output: any;
+```

package/docs/api/foundation-state-machine.abstractmachine.provide.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [provide](./foundation-state-machine.abstractmachine.provide.md)
+
+## AbstractMachine.provide() method
+
+Recreate the internal machine with the provided implementations.
+
+**Signature:**
+
+```typescript
+provide(implementations: InternalMachineImplementations<TContext, TEvent, TAction, TActor, TResolvedTypesMeta, true>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  implementations | InternalMachineImplementations&lt;TContext, TEvent, TAction, TActor, TResolvedTypesMeta, true&gt; | <code>actions</code>, <code>guards</code>, <code>actors</code>... to merge with existing options. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-state-machine.abstractmachine.send.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [send](./foundation-state-machine.abstractmachine.send.md)
+
+## AbstractMachine.send() method
+
+An api to send events to the machine.
+
+**Signature:**
+
+```typescript
+send(event: TEvent): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | TEvent | An event. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-state-machine.abstractmachine.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [start](./foundation-state-machine.abstractmachine.start.md)
+
+## AbstractMachine.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.abstractmachine.startingcontext.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [startingContext](./foundation-state-machine.abstractmachine.startingcontext.md)
+
+## AbstractMachine.startingContext property
+
+The `context` of the machine when started.
+
+**Signature:**
+
+```typescript
+startingContext: Partial<TContext>;
+```

package/docs/api/foundation-state-machine.abstractmachine.startingstate.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [startingState](./foundation-state-machine.abstractmachine.startingstate.md)
+
+## AbstractMachine.startingState property
+
+The `state` of the machine when started. Allows consumers to start a machine from a persisted state.
+
+**Signature:**
+
+```typescript
+startingState: StateValue;
+```

package/docs/api/foundation-state-machine.abstractmachine.state.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [state](./foundation-state-machine.abstractmachine.state.md)
+
+## AbstractMachine.state property
+
+The current `state` of the machine itself. This is not to be confused with state in the data or store sense.
+
+**Signature:**
+
+```typescript
+state: StateValue;
+```

package/docs/api/foundation-state-machine.abstractmachine.stop.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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [stop](./foundation-state-machine.abstractmachine.stop.md)
+
+## AbstractMachine.stop() method
+
+Stop the machine.
+
+**Signature:**
+
+```typescript
+stop(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-state-machine.apierror._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; [APIError](./foundation-state-machine.apierror.md) &gt; [(constructor)](./foundation-state-machine.apierror._constructor_.md)
+
+## APIError.(constructor)
+
+Constructs a new instance of the `APIError` class
+
+**Signature:**
+
+```typescript
+constructor(status: number, data?: unknown, message?: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  status | number |  |
+|  data | unknown | _(Optional)_ |
+|  message | string | _(Optional)_ |
+

package/docs/api/foundation-state-machine.apierror.data.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; [APIError](./foundation-state-machine.apierror.md) &gt; [data](./foundation-state-machine.apierror.data.md)
+
+## APIError.data property
+
+**Signature:**
+
+```typescript
+data?: unknown;
+```

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

@@ -0,0 +1,32 @@
+<!-- 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; [APIError](./foundation-state-machine.apierror.md)
+
+## APIError class
+
+APIError.
+
+**Signature:**
+
+```typescript
+export declare class APIError extends Error 
+```
+**Extends:** Error
+
+## Remarks
+
+Bad server `Response`<!-- -->.
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(status, data, message)](./foundation-state-machine.apierror._constructor_.md) |  | Constructs a new instance of the <code>APIError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data?](./foundation-state-machine.apierror.data.md) |  | unknown | _(Optional)_ |
+|  [status](./foundation-state-machine.apierror.status.md) |  | number |  |
+

package/docs/api/foundation-state-machine.apierror.status.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; [APIError](./foundation-state-machine.apierror.md) &gt; [status](./foundation-state-machine.apierror.status.md)
+
+## APIError.status property
+
+**Signature:**
+
+```typescript
+status: number;
+```

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

@@ -0,0 +1,27 @@
+<!-- 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; [assertEvent](./foundation-state-machine.assertevent.md)
+
+## assertEvent() function
+
+assertEvent.
+
+**Signature:**
+
+```typescript
+export declare function assertEvent<TEvent extends EventObject = EventObject>(event: TEvent, type: TEvent['type']): asserts event is Extract<TEvent, {
+    type: TEvent['type'];
+}>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | TEvent | An event. |
+|  type | TEvent\['type'\] | An event type. |
+
+**Returns:**
+
+asserts event is Extract&lt;TEvent, { type: TEvent\['type'\]; }&gt;
+

package/docs/api/foundation-state-machine.createerrorstatenode.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; [createErrorStateNode](./foundation-state-machine.createerrorstatenode.md)
+
+## createErrorStateNode variable
+
+Creates an error state node.
+
+**Signature:**
+
+```typescript
+createErrorStateNode: (key: string, metaContent?: string, final?: boolean) => StateNodeConfig<any, any, any, any>
+```

package/docs/api/foundation-state-machine.createfetchpolicy.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; [createFetchPolicy](./foundation-state-machine.createfetchpolicy.md)
+
+## createFetchPolicy variable
+
+A fetch policy factory.
+
+**Signature:**
+
+```typescript
+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]>
+```
+
+## Remarks
+
+Will retry network errors and responses with certain status codes up to the specified max attempts.
+

package/docs/api/foundation-state-machine.createresponsedataextractorwithdeserializer.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; [createResponseDataExtractorWithDeserializer](./foundation-state-machine.createresponsedataextractorwithdeserializer.md)
+
+## createResponseDataExtractorWithDeserializer variable
+
+Creates an extractor that applies a deserializer to the extracted response data.
+
+**Signature:**
+
+```typescript
+createResponseDataExtractorWithDeserializer: <TInput = any, TOutput = any>(deserializer: (data: TInput) => Promise<TOutput>, extractor?: ResponseDataExtractor) => ResponseDataExtractor
+```

package/docs/api/foundation-state-machine.defaultfetchconfig.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; [defaultFetchConfig](./foundation-state-machine.defaultfetchconfig.md)
+
+## defaultFetchConfig variable
+
+The default fetch config.
+
+**Signature:**
+
+```typescript
+defaultFetchConfig: FetchConfig
+```

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

@@ -0,0 +1,20 @@
+<!-- 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; [(constructor)](./foundation-state-machine.defaultfetchmachine._constructor_.md)
+
+## DefaultFetchMachine.(constructor)
+
+Constructs a new instance of the `DefaultFetchMachine` class
+
+**Signature:**
+
+```typescript
+constructor(config?: FetchConfig);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  config | [FetchConfig](./foundation-state-machine.fetchconfig.md) | _(Optional)_ |
+

package/docs/api/foundation-state-machine.defaultfetchmachine.getfromcontainer.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; [DefaultFetchMachine](./foundation-state-machine.defaultfetchmachine.md) &gt; [getFromContainer](./foundation-state-machine.defaultfetchmachine.getfromcontainer.md)
+
+## DefaultFetchMachine.getFromContainer() method
+
+Gets the machine from the container.
+
+**Signature:**
+
+```typescript
+getFromContainer(): this;
+```
+**Returns:**
+
+this
+
+## Remarks
+
+Calling `getFromContainer` on an injected machine will return a new instance providing it was registered with the DI as `transient`<!-- -->. This is simply a convenience method, and may be useful as some machines contain 'final' states, meaning once they complete they can no longer receive events. However, if you want to continue to work with your injected machine reference, re-calling [start](./foundation-state-machine.machine.start.md) may also be a viable option.
+
+Please note that machines are injected into other machines to form parts of complex workflows. In such cases, the parent machine will `invoke` or `spawn` the injected machine's `logic` directly to always create a new actor.
+