@genesislcap/foundation-state-machine 14.408.0 → 14.409.0

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

@@ -1,58 +0,0 @@
-<!-- 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; [Machine](./foundation-state-machine.machine.md) &gt; [start](./foundation-state-machine.machine.start.md)
-
-## Machine.start() method
-
-Start the machine.
-
-**Signature:**
-
-```typescript
-start(options?: InterpreterOptions<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>): any;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-InterpreterOptions&lt;StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional InterpreterOptions. Can be used to restore to a previously persisted state.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-any
-
-## 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.machine.startingcontext.md

@@ -1,13 +0,0 @@
-<!-- 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; [Machine](./foundation-state-machine.machine.md) &gt; [startingContext](./foundation-state-machine.machine.startingcontext.md)
-
-## Machine.startingContext property
-
-The `context` of the machine when started.
-
-**Signature:**
-
-```typescript
-readonly startingContext: Partial<TContext>;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [Machine](./foundation-state-machine.machine.md) &gt; [startingState](./foundation-state-machine.machine.startingstate.md)
-
-## Machine.startingState property
-
-The `state` of the machine when started. Allows consumers to start a machine from a persisted state.
-
-**Signature:**
-
-```typescript
-readonly startingState: StateValue;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [Machine](./foundation-state-machine.machine.md) &gt; [state](./foundation-state-machine.machine.state.md)
-
-## Machine.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
-readonly state: StateValue;
-```

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

@@ -1,17 +0,0 @@
-<!-- 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; [Machine](./foundation-state-machine.machine.md) &gt; [stop](./foundation-state-machine.machine.stop.md)
-
-## Machine.stop() method
-
-Stop the machine.
-
-**Signature:**
-
-```typescript
-stop(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-state-machine.machinecontext.error.md

@@ -1,13 +0,0 @@
-<!-- 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; [MachineContext](./foundation-state-machine.machinecontext.md) &gt; [error](./foundation-state-machine.machinecontext.error.md)
-
-## MachineContext.error property
-
-A general machine error. Maybe equal to `errors.lastError`<!-- -->.
-
-**Signature:**
-
-```typescript
-readonly error: any;
-```

package/docs/api/foundation-state-machine.machinecontext.errors.md

@@ -1,13 +0,0 @@
-<!-- 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; [MachineContext](./foundation-state-machine.machinecontext.md) &gt; [errors](./foundation-state-machine.machinecontext.errors.md)
-
-## MachineContext.errors property
-
-A `ErrorMap` of errors that may have occurred during the machine's workflows.
-
-**Signature:**
-
-```typescript
-readonly errors: ErrorMap<ErrorDetailMap>;
-```

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

@@ -1,96 +0,0 @@
-<!-- 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; [MachineContext](./foundation-state-machine.machinecontext.md)
-
-## MachineContext interface
-
-MachineContext interface.
-
-**Signature:**
-
-```typescript
-export interface MachineContext extends XMachineContext 
-```
-**Extends:** XMachineContext
-
-## Remarks
-
-The interface of our xstate based machine contexts that include `error` and `errors` properties. Should be extended.
-
-## Example
-
-Creating a machine context.
-
-```ts
-export interface MyMachineContext extends MachineContext {
-  ...
-};
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[error](./foundation-state-machine.machinecontext.error.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-A general machine error. Maybe equal to `errors.lastError`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[errors](./foundation-state-machine.machinecontext.errors.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-ErrorMap&lt;ErrorDetailMap&gt;
-
-
-</td><td>
-
-A `ErrorMap` of errors that may have occurred during the machine's workflows.
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,66 +0,0 @@
-<!-- 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; [MappingError](./foundation-state-machine.mappingerror.md) &gt; [(constructor)](./foundation-state-machine.mappingerror._constructor_.md)
-
-## MappingError.(constructor)
-
-Constructs a new instance of the `MappingError` class
-
-**Signature:**
-
-```typescript
-constructor(dto?: unknown, message?: string);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dto
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-message
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-state-machine.mappingerror.dto.md

@@ -1,11 +0,0 @@
-<!-- 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; [MappingError](./foundation-state-machine.mappingerror.md) &gt; [dto](./foundation-state-machine.mappingerror.dto.md)
-
-## MappingError.dto property
-
-**Signature:**
-
-```typescript
-dto?: unknown;
-```

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

@@ -1,93 +0,0 @@
-<!-- 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; [MappingError](./foundation-state-machine.mappingerror.md)
-
-## MappingError class
-
-MappingError.
-
-**Signature:**
-
-```typescript
-export declare class MappingError extends Error 
-```
-**Extends:** Error
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(dto, message)](./foundation-state-machine.mappingerror._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `MappingError` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[dto?](./foundation-state-machine.mappingerror.dto.md)
-
-
-</td><td>
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-