@genesislcap/foundation-state-machine 14.70.0

package/docs/api/foundation-state-machine.isactorerrorevent.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; [isActorErrorEvent](./foundation-state-machine.isactorerrorevent.md)
+
+## isActorErrorEvent variable
+
+isActorErrorEvent.
+
+**Signature:**
+
+```typescript
+isActorErrorEvent: <TData = any>(actorId: string, event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
+```

package/docs/api/foundation-state-machine.isapierror.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; [isAPIError](./foundation-state-machine.isapierror.md)
+
+## isAPIError variable
+
+**Signature:**
+
+```typescript
+isAPIError: (error: unknown) => boolean
+```

package/docs/api/foundation-state-machine.isdoneinvokeevent.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; [isDoneInvokeEvent](./foundation-state-machine.isdoneinvokeevent.md)
+
+## isDoneInvokeEvent variable
+
+isDoneInvokeEvent.
+
+**Signature:**
+
+```typescript
+isDoneInvokeEvent: <TData = any>(event: EventObject | DoneInvokeEvent<TData>) => event is DoneInvokeEvent<TData>
+```

package/docs/api/foundation-state-machine.iserrorcustomevent.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; [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md)
+
+## isErrorCustomEvent variable
+
+isErrorCustomEvent.
+
+**Signature:**
+
+```typescript
+isErrorCustomEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
+```
+
+## Remarks
+
+What `escalate` from a child is typed as.
+

package/docs/api/foundation-state-machine.iserrorevent.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; [isErrorEvent](./foundation-state-machine.iserrorevent.md)
+
+## isErrorEvent variable
+
+isErrorEvent.
+
+**Signature:**
+
+```typescript
+isErrorEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
+```

package/docs/api/foundation-state-machine.iserrortype.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; [isErrorType](./foundation-state-machine.iserrortype.md)
+
+## isErrorType variable
+
+isErrorType.
+
+**Signature:**
+
+```typescript
+isErrorType: <TType extends ErrorConstructor>(type: TType) => (event: any) => boolean
+```

package/docs/api/foundation-state-machine.isgenesisservererror.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; [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md)
+
+## isGenesisServerError variable
+
+**Signature:**
+
+```typescript
+isGenesisServerError: (error: unknown) => boolean
+```

package/docs/api/foundation-state-machine.ismappingerror.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; [isMappingError](./foundation-state-machine.ismappingerror.md)
+
+## isMappingError variable
+
+**Signature:**
+
+```typescript
+isMappingError: (error: unknown) => boolean
+```

package/docs/api/foundation-state-machine.isnetworkerror.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; [isNetworkError](./foundation-state-machine.isnetworkerror.md)
+
+## isNetworkError variable
+
+**Signature:**
+
+```typescript
+isNetworkError: (error: unknown) => boolean
+```

package/docs/api/foundation-state-machine.isnotfounderror.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; [isNotFoundError](./foundation-state-machine.isnotfounderror.md)
+
+## isNotFoundError variable
+
+**Signature:**
+
+```typescript
+isNotFoundError: (error: {
+    status?: number;
+}) => boolean
+```

package/docs/api/foundation-state-machine.issyntaxerror.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; [isSyntaxError](./foundation-state-machine.issyntaxerror.md)
+
+## isSyntaxError variable
+
+isSyntaxError.
+
+**Signature:**
+
+```typescript
+isSyntaxError: ({ event }: {
+    event: any;
+}) => boolean
+```

package/docs/api/foundation-state-machine.istypeerror.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; [isTypeError](./foundation-state-machine.istypeerror.md)
+
+## isTypeError variable
+
+isTypeError.
+
+**Signature:**
+
+```typescript
+isTypeError: ({ event }: {
+    event: any;
+}) => boolean
+```

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

@@ -0,0 +1,12 @@
+<!-- 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; [logger](./foundation-state-machine.logger.md)
+
+## logger variable
+
+
+**Signature:**
+
+```typescript
+logger: import("@genesislcap/foundation-utils").Logger
+```

package/docs/api/foundation-state-machine.machine.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; [Machine](./foundation-state-machine.machine.md) &gt; [actor](./foundation-state-machine.machine.actor.md)
+
+## Machine.actor property
+
+Optional actor
+
+**Signature:**
+
+```typescript
+readonly 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.machine.binding.md

@@ -0,0 +1,47 @@
+<!-- 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; [binding](./foundation-state-machine.machine.binding.md)
+
+## Machine.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;
+
+## Example 1
+
+TS attains the value type information from the machine's interface.
+
+```ts
+this.myMachine.binding(x => x.context.data, value => {...}); // value is typeof data
+```
+
+## Example 2
+
+You can also use the underlying BindingObserver api should you prefer.
+
+```ts
+this.myMachine.binding(x => x.error).subscribe({
+  handleChange(binding, args) {
+    ...
+  }
+})
+```
+

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

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

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

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

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

@@ -0,0 +1,35 @@
+<!-- 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; [getFromContainer](./foundation-state-machine.machine.getfromcontainer.md)
+
+## Machine.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.
+
+## Example
+
+Invoke an injected machine's `logic` from a parent machine
+
+```ts
+invoke: {
+   id: 'dataFetcher',
+   src: fetchMachine.machine, // < Or `src: 'fetcher'`, and create that actor to interact with the injected machine.
+   ...
+}
+```
+

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

@@ -0,0 +1,35 @@
+<!-- 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; [hasTag](./foundation-state-machine.machine.hastag.md)
+
+## Machine.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.
+
+## Example
+
+
+```ts
+if (machine.hasTag('pending')) { ... }
+```
+

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

@@ -0,0 +1,35 @@
+<!-- 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; [matches](./foundation-state-machine.machine.matches.md)
+
+## Machine.matches() method
+
+Check `state` matches provided value.
+
+**Signature:**
+
+```typescript
+matches(value: StateValueFrom<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | StateValueFrom&lt;StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;&gt; | A state value. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+Can be useful if you need to conditionally run logic or render markup.
+
+## Example
+
+
+```ts
+if (machine.matches('inactive')) { ... }
+```
+

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

@@ -0,0 +1,101 @@
+<!-- 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)
+
+## Machine interface
+
+Machine interface.
+
+**Signature:**
+
+```typescript
+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>> 
+```
+
+## Remarks
+
+The interface of our xstate based machines or logic workflows. These contain bindable properties for convenience. Should be extended.
+
+## Example 1
+
+Creating a machine in the DI.
+
+```ts
+export interface MyMachine extends Machine<MyMachineContext, MyMachineEvent> {
+  readonly service: MyService;
+  ...
+}
+export class DefaultMyMachine
+  extends AbstractMachine<MyMachineContext, MyMachineEvent>
+  implements MyMachine
+{
+  constructor(@MyService readonly service: MyService) {
+    super();
+    this.machine = createMachine<MyMachineContext, MyMachineEvent>(...);
+    this.start(); // < Call now or later to ready the machine.
+  }
+  start(
+    options: InterpreterOptions<typeof this.machine> = {
+      input: myDefaultContext,
+    },
+  ) {
+    super.start(options);
+  }
+}
+// Whether the machine should be `transient` or a `singleton` probably depends on the use case and if it contains a `final` state.
+export const MyMachine = DI.createInterface<MyMachine>((x) => x.transient(DefaultMyMachine));
+```
+Machines are bindable from templates and other logic.
+
+## Example 2
+
+Surface errors in a template.
+
+```ts
+${when(
+  (x) => !!x.myMachine.errors.size,
+  html<MyComponent>`
+    <span>${(x) => x.myMachine.errors.messages}</span>
+  `,
+)}
+```
+
+## Example 3
+
+Use context data in a class.
+
+```ts
+this.myMachine.binding((x) => x.context.data, (value) => {
+  // use data
+});
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [actor?](./foundation-state-machine.machine.actor.md) | <code>readonly</code> | InterpreterFrom&lt;StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;&gt; | _(Optional)_ Optional actor |
+|  [complete](./foundation-state-machine.machine.complete.md) | <code>readonly</code> | boolean | Indicates if the machine has completed the happy path. |
+|  [context](./foundation-state-machine.machine.context.md) | <code>readonly</code> | 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.machine.error.md) | <code>readonly</code> | any | A general machine error. Likely equal to <code>errors.lastError</code>. |
+|  [errors](./foundation-state-machine.machine.errors.md) | <code>readonly</code> | ErrorMap&lt;ErrorDetailMap&gt; | An  of errors that may have occurred during the machine's workflows. |
+|  [machine](./foundation-state-machine.machine.machine.md) | <code>readonly</code> | StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt; | Mandatory machine property. |
+|  [output](./foundation-state-machine.machine.output.md) | <code>readonly</code> | any | Holds successful machine output if any. |
+|  [startingContext](./foundation-state-machine.machine.startingcontext.md) | <code>readonly</code> | Partial&lt;TContext&gt; | The <code>context</code> of the machine when started. |
+|  [startingState](./foundation-state-machine.machine.startingstate.md) | <code>readonly</code> | StateValue | The <code>state</code> of the machine when started. Allows consumers to start a machine from a persisted state. |
+|  [state](./foundation-state-machine.machine.state.md) | <code>readonly</code> | 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 | Description |
+|  --- | --- |
+|  [binding(token, subscriberChangeCallback, isVolatileBinding, context)](./foundation-state-machine.machine.binding.md) | An api to allow the observation of values and arbitrary bindings outside the template engine. |
+|  [getFromContainer()](./foundation-state-machine.machine.getfromcontainer.md) | Gets the machine from the container. |
+|  [hasTag(tag)](./foundation-state-machine.machine.hastag.md) | Check <code>tags</code> contain provided tag. |
+|  [matches(value)](./foundation-state-machine.machine.matches.md) | Check <code>state</code> matches provided value. |
+|  [onSendEvent(event)](./foundation-state-machine.machine.onsendevent.md) | A custom event handler to send events to the machine. |
+|  [provide(implementations)](./foundation-state-machine.machine.provide.md) | Recreate the internal machine with the provided implementations. |
+|  [send(event)](./foundation-state-machine.machine.send.md) | An api to send events to the machine. |
+|  [start(options)](./foundation-state-machine.machine.start.md) | Start the machine. |
+|  [stop()](./foundation-state-machine.machine.stop.md) | Stop the machine. |
+

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

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

package/docs/api/foundation-state-machine.machine.provide.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; [Machine](./foundation-state-machine.machine.md) &gt; [provide](./foundation-state-machine.machine.provide.md)
+
+## Machine.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
+
+## Example
+
+Using an existing machine with a custom implementation.
+
+```ts
+@MyMachine readonly machine: MyMachine;
+...
+this.machine.provide({
+  actors: {
+    serviceCallX: fromPromise(async ({ input }) => Promise.resolve(new Error('Overridden serviceCallX'))),
+    onSuccess: (context) => successHandlerInHost(context.data)
+  },
+  guards: {
+    isAssured: ({ context }) => true,
+  },
+});
+// When you change the machine it will stop if running, so you'll have to call {@link Machine.start | start} again.
+this.machine.start();
+```
+

package/docs/api/foundation-state-machine.machine.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; [Machine](./foundation-state-machine.machine.md) &gt; [send](./foundation-state-machine.machine.send.md)
+
+## Machine.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
+