@genesislcap/foundation-state-machine 14.408.0 → 14.409.0

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

@@ -1,600 +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)
-
-## foundation-state-machine package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[APIError](./foundation-state-machine.apierror.md)
-
-
-</td><td>
-
-APIError.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultFetchMachine](./foundation-state-machine.defaultfetchmachine.md)
-
-
-</td><td>
-
-Default FetchMachine.
-
-
-</td></tr>
-<tr><td>
-
-[GenesisServerError](./foundation-state-machine.genesisservererror.md)
-
-
-</td><td>
-
-GenesisServerError.
-
-
-</td></tr>
-<tr><td>
-
-[MappingError](./foundation-state-machine.mappingerror.md)
-
-
-</td><td>
-
-MappingError.
-
-
-</td></tr>
-<tr><td>
-
-[NetworkError](./foundation-state-machine.networkerror.md)
-
-
-</td><td>
-
-NetworkError.
-
-
-</td></tr>
-</tbody></table>
-
-## Abstract Classes
-
-<table><thead><tr><th>
-
-Abstract Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[AbstractMachine](./foundation-state-machine.abstractmachine.md)
-
-
-</td><td>
-
-AbstractMachine base class.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[assertEvent(event, type)](./foundation-state-machine.assertevent.md)
-
-
-</td><td>
-
-assertEvent.
-
-
-</td></tr>
-<tr><td>
-
-[createErrorStateNode(key, metaContent, final)](./foundation-state-machine.createerrorstatenode.md)
-
-
-</td><td>
-
-Creates an error state node.
-
-
-</td></tr>
-<tr><td>
-
-[createFetchPolicy(maxAttempts, retryCodes, backoff, timeoutDuration, logEvents)](./foundation-state-machine.createfetchpolicy.md)
-
-
-</td><td>
-
-A fetch policy factory.
-
-
-</td></tr>
-<tr><td>
-
-[createResponseDataExtractorWithDeserializer(deserializer, extractor)](./foundation-state-machine.createresponsedataextractorwithdeserializer.md)
-
-
-</td><td>
-
-Creates an extractor that applies a deserializer to the extracted response data.
-
-
-</td></tr>
-<tr><td>
-
-[errorWorkflowInput(key)](./foundation-state-machine.errorworkflowinput.md)
-
-
-</td><td>
-
-Error workflow input.
-
-
-</td></tr>
-<tr><td>
-
-[isAbortError({ event })](./foundation-state-machine.isaborterror.md)
-
-
-</td><td>
-
-isAbortError.
-
-
-</td></tr>
-<tr><td>
-
-[isActorErrorEvent(actorId, event)](./foundation-state-machine.isactorerrorevent.md)
-
-
-</td><td>
-
-isActorErrorEvent.
-
-
-</td></tr>
-<tr><td>
-
-[isAPIError(error)](./foundation-state-machine.isapierror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isDoneInvokeEvent(event)](./foundation-state-machine.isdoneinvokeevent.md)
-
-
-</td><td>
-
-isDoneInvokeEvent.
-
-
-</td></tr>
-<tr><td>
-
-[isErrorCustomEvent(event)](./foundation-state-machine.iserrorcustomevent.md)
-
-
-</td><td>
-
-isErrorCustomEvent.
-
-
-</td></tr>
-<tr><td>
-
-[isErrorEvent(event)](./foundation-state-machine.iserrorevent.md)
-
-
-</td><td>
-
-isErrorEvent.
-
-
-</td></tr>
-<tr><td>
-
-[isErrorType(type)](./foundation-state-machine.iserrortype.md)
-
-
-</td><td>
-
-isErrorType.
-
-
-</td></tr>
-<tr><td>
-
-[isEventWithParams(event)](./foundation-state-machine.iseventwithparams.md)
-
-
-</td><td>
-
-isEventWithParams.
-
-
-</td></tr>
-<tr><td>
-
-[isGenesisServerError(error)](./foundation-state-machine.isgenesisservererror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isMappingError(error)](./foundation-state-machine.ismappingerror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isNetworkError(error)](./foundation-state-machine.isnetworkerror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isNotFoundError(error)](./foundation-state-machine.isnotfounderror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isSyntaxError({ event })](./foundation-state-machine.issyntaxerror.md)
-
-
-</td><td>
-
-isSyntaxError.
-
-
-</td></tr>
-<tr><td>
-
-[isTypeError({ event })](./foundation-state-machine.istypeerror.md)
-
-
-</td><td>
-
-isTypeError.
-
-
-</td></tr>
-<tr><td>
-
-[isUnauthorizedError(error)](./foundation-state-machine.isunauthorizederror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[setErrorByKey(key)](./foundation-state-machine.seterrorbykey.md)
-
-
-</td><td>
-
-Set error by key action.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[FetchConfig](./foundation-state-machine.fetchconfig.md)
-
-
-</td><td>
-
-FetchConfig interface.
-
-
-</td></tr>
-<tr><td>
-
-[FetchMachine](./foundation-state-machine.fetchmachine.md)
-
-
-</td><td>
-
-FetchMachine interface.
-
-
-</td></tr>
-<tr><td>
-
-[FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md)
-
-
-</td><td>
-
-FetchMachineContext interface.
-
-
-</td></tr>
-<tr><td>
-
-[Machine](./foundation-state-machine.machine.md)
-
-
-</td><td>
-
-Machine interface.
-
-
-</td></tr>
-<tr><td>
-
-[MachineContext](./foundation-state-machine.machinecontext.md)
-
-
-</td><td>
-
-MachineContext interface.
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[defaultFetchConfig](./foundation-state-machine.defaultfetchconfig.md)
-
-
-</td><td>
-
-The default fetch config.
-
-
-</td></tr>
-<tr><td>
-
-[defaultFetchMachineContext](./foundation-state-machine.defaultfetchmachinecontext.md)
-
-
-</td><td>
-
-Default FetchMachineContext.
-
-
-</td></tr>
-<tr><td>
-
-[defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md)
-
-
-</td><td>
-
-The default fetch policy.
-
-
-</td></tr>
-<tr><td>
-
-[defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md)
-
-
-</td><td>
-
-ResponseDataExtractor type.
-
-
-</td></tr>
-<tr><td>
-
-[defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md)
-
-
-</td><td>
-
-ResponseOkChecker type.
-
-
-</td></tr>
-<tr><td>
-
-[defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md)
-
-
-</td><td>
-
-Default retry stats codes.
-
-
-</td></tr>
-<tr><td>
-
-[escalateError](./foundation-state-machine.escalateerror.md)
-
-
-</td><td>
-
-Escalate context error action.
-
-
-</td></tr>
-<tr><td>
-
-[logger](./foundation-state-machine.logger.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[setError](./foundation-state-machine.seterror.md)
-
-
-</td><td>
-
-Set error action.
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ErrorWorkflowInput](./foundation-state-machine.errorworkflowinput.md)
-
-
-</td><td>
-
-ErrorWorkflowInput type.
-
-
-</td></tr>
-<tr><td>
-
-[FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md)
-
-
-</td><td>
-
-FetchMachineEvent type.
-
-
-</td></tr>
-<tr><td>
-
-[FetchMachineEventMap](./foundation-state-machine.fetchmachineeventmap.md)
-
-
-</td><td>
-
-FetchMachineEventMap type.
-
-
-</td></tr>
-<tr><td>
-
-[FetchMachineOutput](./foundation-state-machine.fetchmachineoutput.md)
-
-
-</td><td>
-
-FetchMachineOutput type.
-
-
-</td></tr>
-<tr><td>
-
-[ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md)
-
-
-</td><td>
-
-ResponseDataExtractor type.
-
-
-</td></tr>
-<tr><td>
-
-[ResponseOkChecker](./foundation-state-machine.responseokchecker.md)
-
-
-</td><td>
-
-ResponseOkChecker type.
-
-
-</td></tr>
-</tbody></table>
-

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

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