@genesislcap/foundation-state-machine 14.408.0 → 14.409.0

package/docs/api/foundation-state-machine.iserrorcustomevent.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; [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md)
-
-## isErrorCustomEvent() function
-
-isErrorCustomEvent.
-
-**Signature:**
-
-```typescript
-isErrorCustomEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-event
-
-
-</td><td>
-
-EventObject \| ErrorEvent&lt;TData&gt;
-
-
-</td><td>
-
-An event.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-event is ErrorEvent&lt;TData&gt;
-
-## Remarks
-
-What `escalate` from a child is typed as.
-

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

@@ -1,54 +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; [isErrorEvent](./foundation-state-machine.iserrorevent.md)
-
-## isErrorEvent() function
-
-isErrorEvent.
-
-**Signature:**
-
-```typescript
-isErrorEvent: <TData = any>(event: EventObject | ErrorEvent<TData>) => event is ErrorEvent<TData>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-event
-
-
-</td><td>
-
-EventObject \| ErrorEvent&lt;TData&gt;
-
-
-</td><td>
-
-An event.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-event is ErrorEvent&lt;TData&gt;
-

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

@@ -1,54 +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; [isErrorType](./foundation-state-machine.iserrortype.md)
-
-## isErrorType() function
-
-isErrorType.
-
-**Signature:**
-
-```typescript
-isErrorType: <TType extends ErrorConstructor>(type: TType) => (event: any) => boolean
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-TType
-
-
-</td><td>
-
-An event type.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(event: any) =&gt; boolean
-

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

@@ -1,54 +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; [isEventWithParams](./foundation-state-machine.iseventwithparams.md)
-
-## isEventWithParams() function
-
-isEventWithParams.
-
-**Signature:**
-
-```typescript
-isEventWithParams: (event: AnyEventObject) => event is ParameterizedObject
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-event
-
-
-</td><td>
-
-AnyEventObject
-
-
-</td><td>
-
-An event.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-event is ParameterizedObject
-

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

@@ -1,52 +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; [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md)
-
-## isGenesisServerError() function
-
-**Signature:**
-
-```typescript
-isGenesisServerError: (error: unknown) => error is GenesisServerError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [GenesisServerError](./foundation-state-machine.genesisservererror.md)
-

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

@@ -1,52 +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; [isMappingError](./foundation-state-machine.ismappingerror.md)
-
-## isMappingError() function
-
-**Signature:**
-
-```typescript
-isMappingError: (error: unknown) => error is MappingError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [MappingError](./foundation-state-machine.mappingerror.md)
-

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

@@ -1,52 +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; [isNetworkError](./foundation-state-machine.isnetworkerror.md)
-
-## isNetworkError() function
-
-**Signature:**
-
-```typescript
-isNetworkError: (error: unknown) => error is NetworkError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [NetworkError](./foundation-state-machine.networkerror.md)
-

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

@@ -1,54 +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; [isNotFoundError](./foundation-state-machine.isnotfounderror.md)
-
-## isNotFoundError() function
-
-**Signature:**
-
-```typescript
-isNotFoundError: (error: {
-    status?: number;
-}) => error is APIError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-{ status?: number; }
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [APIError](./foundation-state-machine.apierror.md)
-

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

@@ -1,54 +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; [isSyntaxError](./foundation-state-machine.issyntaxerror.md)
-
-## isSyntaxError() function
-
-isSyntaxError.
-
-**Signature:**
-
-```typescript
-isSyntaxError: ({ event }: {
-    event: any;
-}) => boolean
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-{ event }
-
-
-</td><td>
-
-{ event: any; }
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,54 +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; [isTypeError](./foundation-state-machine.istypeerror.md)
-
-## isTypeError() function
-
-isTypeError.
-
-**Signature:**
-
-```typescript
-isTypeError: ({ event }: {
-    event: any;
-}) => boolean
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-{ event }
-
-
-</td><td>
-
-{ event: any; }
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,54 +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; [isUnauthorizedError](./foundation-state-machine.isunauthorizederror.md)
-
-## isUnauthorizedError() function
-
-**Signature:**
-
-```typescript
-isUnauthorizedError: (error: {
-    status?: number;
-}) => error is APIError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-{ status?: number; }
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [APIError](./foundation-state-machine.apierror.md)
-

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

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

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

@@ -1,18 +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; [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.
-