@xmachines/docs 1.0.0-beta.13 → 1.0.0-beta.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
- package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
- package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
- package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
- package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
- package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
- package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
- package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
- package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
- package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
- package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
- package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
- package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
- package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
- package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
- package/api/@xmachines/shared/functions/xmAliases.md +1 -1
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createRouteMap(machine): RouteMap;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-vue-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-vue-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/create-route-map.ts#L9)
|
|
10
10
|
|
|
11
11
|
## Parameters
|
|
12
12
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteMapping
|
|
4
4
|
|
|
5
|
-
Defined in: [play-vue-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-vue-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/types.ts#L10)
|
|
6
6
|
|
|
7
7
|
Mapping configuration between XMachines state IDs and Vue Router route names
|
|
8
8
|
|
|
@@ -10,6 +10,6 @@ Mapping configuration between XMachines state IDs and Vue Router route names
|
|
|
10
10
|
|
|
11
11
|
| Property | Modifier | Type | Description | Defined in |
|
|
12
12
|
| ------------------------------------------- | ---------- | -------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
-
| <a id="property-pattern"></a> `pattern?` | `readonly` | `string` | Optional URL pattern for debugging | [play-vue-router/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
14
|
-
| <a id="property-routename"></a> `routeName` | `readonly` | `string` | Vue Router route name | [play-vue-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
15
|
-
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., '#home', '#profile') | [play-vue-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
13
|
+
| <a id="property-pattern"></a> `pattern?` | `readonly` | `string` | Optional URL pattern for debugging | [play-vue-router/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/types.ts#L16) |
|
|
14
|
+
| <a id="property-routename"></a> `routeName` | `readonly` | `string` | Vue Router route name | [play-vue-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/types.ts#L14) |
|
|
15
|
+
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., '#home', '#profile') | [play-vue-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/types.ts#L12) |
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-vue-router/src/play-router-provider.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-vue-router/src/play-router-provider.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/play-router-provider.ts#L9)
|
|
@@ -64,4 +64,4 @@ const PlayRouterProvider: DefineComponent<
|
|
|
64
64
|
>;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [play-vue-router/src/play-router-provider.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
67
|
+
Defined in: [play-vue-router/src/play-router-provider.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-vue-router/src/play-router-provider.ts#L11)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: PlayerActor\<TMachine\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L120)
|
|
6
6
|
|
|
7
7
|
Concrete XState actor implementing Play Architecture signal protocol
|
|
8
8
|
|
|
@@ -108,7 +108,7 @@ new PlayerActor<TMachine>(
|
|
|
108
108
|
input?): PlayerActor<TMachine>;
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
111
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L142)
|
|
112
112
|
|
|
113
113
|
#### Parameters
|
|
114
114
|
|
|
@@ -132,17 +132,17 @@ Defined in: [packages/play-xstate/src/player-actor.ts:142](https://gitlab.com/xm
|
|
|
132
132
|
| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
|
|
133
133
|
| ------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
134
134
|
| <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`_parent`](../../play-actor/classes/AbstractActor.md#property-_parent) | node_modules/xstate/dist/declarations/src/createActor.d.ts:33 |
|
|
135
|
-
| <a id="property-catalog"></a> `catalog` | `public` | [`Catalog`](../type-aliases/Catalog.md) | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | - | - | [packages/play-xstate/src/player-actor.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
135
|
+
| <a id="property-catalog"></a> `catalog` | `public` | [`Catalog`](../type-aliases/Catalog.md) | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | - | - | [packages/play-xstate/src/player-actor.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L140) |
|
|
136
136
|
| <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`clock`](../../play-actor/classes/AbstractActor.md#property-clock) | node_modules/xstate/dist/declarations/src/createActor.d.ts:25 |
|
|
137
|
-
| <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | - | - | [packages/play-xstate/src/player-actor.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
138
|
-
| <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | - | - | [packages/play-xstate/src/player-actor.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
137
|
+
| <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | - | - | [packages/play-xstate/src/player-actor.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L138) |
|
|
138
|
+
| <a id="property-currentview"></a> `currentView` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](../../play-actor/interfaces/ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | - | - | [packages/play-xstate/src/player-actor.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L139) |
|
|
139
139
|
| <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`id`](../../play-actor/classes/AbstractActor.md#property-id) | node_modules/xstate/dist/declarations/src/createActor.d.ts:28 |
|
|
140
140
|
| <a id="property-logic"></a> `logic` | `public` | [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`logic`](../../play-actor/classes/AbstractActor.md#property-logic) | node_modules/xstate/dist/declarations/src/createActor.d.ts:18 |
|
|
141
141
|
| <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`options`](../../play-actor/classes/AbstractActor.md#property-options) | node_modules/xstate/dist/declarations/src/createActor.d.ts:26 |
|
|
142
142
|
| <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<`any`, `any`, `any`\> | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`ref`](../../play-actor/classes/AbstractActor.md#property-ref) | node_modules/xstate/dist/declarations/src/createActor.d.ts:34 |
|
|
143
143
|
| <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`sessionId`](../../play-actor/classes/AbstractActor.md#property-sessionid) | node_modules/xstate/dist/declarations/src/createActor.d.ts:38 |
|
|
144
144
|
| <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`src`](../../play-actor/classes/AbstractActor.md#property-src) | node_modules/xstate/dist/declarations/src/createActor.d.ts:42 |
|
|
145
|
-
| <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
145
|
+
| <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`AnyMachineSnapshot`](https://www.jsdocs.io/package/xstate#AnyMachineSnapshot)\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L137) |
|
|
146
146
|
| <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`system`](../../play-actor/classes/AbstractActor.md#property-system) | node_modules/xstate/dist/declarations/src/createActor.d.ts:40 |
|
|
147
147
|
| <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | node_modules/xstate/dist/declarations/src/createActor.d.ts:36 |
|
|
148
148
|
|
|
@@ -172,7 +172,7 @@ Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:153
|
|
|
172
172
|
dispose(): void;
|
|
173
173
|
```
|
|
174
174
|
|
|
175
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:434](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
175
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:434](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L434)
|
|
176
176
|
|
|
177
177
|
Convenience dispose method for cleanup
|
|
178
178
|
|
|
@@ -224,7 +224,7 @@ https://stately.ai/docs/persistence
|
|
|
224
224
|
getSnapshot(): SnapshotFrom<TMachine>;
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
227
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L307)
|
|
228
228
|
|
|
229
229
|
Get current snapshot
|
|
230
230
|
|
|
@@ -275,7 +275,7 @@ Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
|
|
|
275
275
|
send(event): void;
|
|
276
276
|
```
|
|
277
277
|
|
|
278
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
278
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L282)
|
|
279
279
|
|
|
280
280
|
Send event to actor
|
|
281
281
|
|
|
@@ -314,7 +314,7 @@ actor.send({ type: "play.route", to: "#home" });
|
|
|
314
314
|
start(): this;
|
|
315
315
|
```
|
|
316
316
|
|
|
317
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
317
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L239)
|
|
318
318
|
|
|
319
319
|
Start the actor
|
|
320
320
|
|
|
@@ -336,7 +336,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
|
|
|
336
336
|
stop(): this;
|
|
337
337
|
```
|
|
338
338
|
|
|
339
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:253](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
339
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:253](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/player-actor.ts#L253)
|
|
340
340
|
|
|
341
341
|
Stop the actor and cleanup
|
|
342
342
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function buildRouteUrl(routeTemplate, context?): string;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/build-url.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/build-url.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/build-url.ts#L28)
|
|
10
10
|
|
|
11
11
|
Build full URL from route template and context
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function composeGuards<TContext, TEvent>(guards): ComposedGuard;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/compose.ts#L77)
|
|
10
10
|
|
|
11
11
|
Compose guards with AND logic using XState's and() helper
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function composeGuardsOr<TContext, TEvent>(guards): ComposedGuard;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/compose.ts#L143)
|
|
10
10
|
|
|
11
11
|
Compose guards with OR logic using XState's or() helper
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function definePlayer<TMachine, TCatalog>(config): PlayerFactory<TMachine>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/define-player.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/define-player.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/define-player.ts#L111)
|
|
10
10
|
|
|
11
11
|
Create a player factory from XState machine and catalog
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function deriveRoute(stateMeta): string | null;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/derive-route.ts#L90)
|
|
10
10
|
|
|
11
11
|
Derive route from XState state metadata
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function eventMatches<TEvent>(eventType): Guard<unknown, TEvent>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/helpers.ts#L49)
|
|
10
10
|
|
|
11
11
|
Check if event type matches expected type
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function formatPlayRouteTransitions<T>(machineConfig): T;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L65)
|
|
10
10
|
|
|
11
11
|
Formats play.route transitions from declarative route configs
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function hasContext<TContext>(path): Guard<TContext, PlayEvent>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/helpers.ts#L23)
|
|
10
10
|
|
|
11
11
|
Check if context has a truthy value at path
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function isAbsoluteRoute(path): boolean;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/derive-route.ts#L150)
|
|
10
10
|
|
|
11
11
|
Check if route path is absolute
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function mergeViewProps(view, context): Record<string, unknown>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L115)
|
|
10
10
|
|
|
11
11
|
Merge view metadata with context for props
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function negateGuard<TContext, TEvent>(guard): ComposedGuard;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/compose.ts#L203)
|
|
10
10
|
|
|
11
11
|
Negate a guard using XState's not() helper
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function stateMatches<TContext>(stateValue): Guard<TContext, PlayEvent>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/helpers.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/helpers.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/helpers.ts#L75)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function validateComponentBinding(view, catalog): void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/catalog/validate-binding.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/catalog/validate-binding.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-binding.ts#L22)
|
|
10
10
|
|
|
11
11
|
Validate component binding against catalog
|
|
12
12
|
|
|
@@ -10,7 +10,7 @@ Implementation — shared by both overloads
|
|
|
10
10
|
function validateViewProps<TCatalog>(componentName, props, catalog): ValidationResult;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
13
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L35)
|
|
14
14
|
|
|
15
15
|
Validate view props against Zod schema — generic overload for typed catalogs
|
|
16
16
|
|
|
@@ -44,7 +44,7 @@ Zod parse result
|
|
|
44
44
|
function validateViewProps(componentName, props, catalog): ValidationResult;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
47
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L64)
|
|
48
48
|
|
|
49
49
|
Validate view props against Zod schema — base overload for untyped catalogs
|
|
50
50
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: CatalogEntry
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/catalog/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-xstate/src/catalog/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/types.ts#L9)
|
|
6
6
|
|
|
7
7
|
UI component catalog entry with schema and component reference
|
|
8
8
|
|
|
@@ -12,5 +12,5 @@ Per CONTEXT.md: String keys reference components, Zod schemas validate props
|
|
|
12
12
|
|
|
13
13
|
| Property | Type | Description | Defined in |
|
|
14
14
|
| ------------------------------------------- | ---------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
-
| <a id="property-component"></a> `component` | `unknown` | React component (or other framework component) | [packages/play-xstate/src/catalog/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
16
|
-
| <a id="property-schema"></a> `schema` | `ZodType`\<`unknown`\> | Zod schema for component props | [packages/play-xstate/src/catalog/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
15
|
+
| <a id="property-component"></a> `component` | `unknown` | React component (or other framework component) | [packages/play-xstate/src/catalog/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/types.ts#L13) |
|
|
16
|
+
| <a id="property-schema"></a> `schema` | `ZodType`\<`unknown`\> | Zod schema for component props | [packages/play-xstate/src/catalog/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/types.ts#L11) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: PlayerConfig\<TMachine, TCatalog\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L9)
|
|
6
6
|
|
|
7
7
|
Configuration for definePlayer()
|
|
8
8
|
|
|
@@ -19,6 +19,6 @@ Per CONTEXT.md: Single config object with machine, catalog, options
|
|
|
19
19
|
|
|
20
20
|
| Property | Type | Description | Defined in |
|
|
21
21
|
| ---------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
22
|
-
| <a id="property-catalog"></a> `catalog?` | `TCatalog` | UI component catalog (optional - allows machines without UI) | [packages/play-xstate/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
23
|
-
| <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
24
|
-
| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
22
|
+
| <a id="property-catalog"></a> `catalog?` | `TCatalog` | UI component catalog (optional - allows machines without UI) | [packages/play-xstate/src/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L17) |
|
|
23
|
+
| <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L14) |
|
|
24
|
+
| <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L20) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: PlayerOptions\<TMachine\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L28)
|
|
6
6
|
|
|
7
7
|
Player lifecycle hooks
|
|
8
8
|
|
|
@@ -18,9 +18,9 @@ Per CONTEXT.md: Rich set of hooks for observability
|
|
|
18
18
|
|
|
19
19
|
| Property | Type | Description | Defined in |
|
|
20
20
|
| ------------------------------------------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
-
| <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
22
|
-
| <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
23
|
-
| <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
24
|
-
| <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
25
|
-
| <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
26
|
-
| <a id="property-propvalidation"></a> `propValidation?` | `"strict"` \| `"lenient"` | Prop validation failure mode (default: 'lenient') - 'lenient': On validation failure, call onError hook and render with unvalidated props (current behavior). Documents as explicit trade-off. - 'strict': On validation failure, call onError hook and set viewSignal to null (no render). Blocks rendering until machine transitions to a state with valid props. | [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
21
|
+
| <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L46) |
|
|
22
|
+
| <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L30) |
|
|
23
|
+
| <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L43) |
|
|
24
|
+
| <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L33) |
|
|
25
|
+
| <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L36) |
|
|
26
|
+
| <a id="property-propvalidation"></a> `propValidation?` | `"strict"` \| `"lenient"` | Prop validation failure mode (default: 'lenient') - 'lenient': On validation failure, call onError hook and render with unvalidated props (current behavior). Documents as explicit trade-off. - 'strict': On validation failure, call onError hook and set viewSignal to null (no render). Blocks rendering until machine transitions to a state with valid props. | [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L57) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteContext
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/types.ts#L11)
|
|
6
6
|
|
|
7
7
|
Route build context from machine context
|
|
8
8
|
|
|
@@ -16,7 +16,7 @@ Route build context from machine context
|
|
|
16
16
|
|
|
17
17
|
| Property | Type | Description | Defined in |
|
|
18
18
|
| ------------------------------------------------ | ------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
19
|
-
| <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
20
|
-
| <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
21
|
-
| <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
22
|
-
| <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
19
|
+
| <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/types.ts#L13) |
|
|
20
|
+
| <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/types.ts#L19) |
|
|
21
|
+
| <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/types.ts#L17) |
|
|
22
|
+
| <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/types.ts#L15) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type Catalog = Catalog | Record<string, CatalogEntry>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/catalog/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/catalog/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/types.ts#L28)
|
|
10
10
|
|
|
11
11
|
Component catalog mapping
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type ComposedGuard = GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/compose.ts#L14)
|
|
10
10
|
|
|
11
11
|
Narrowest public return type for guard composition helpers.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type Guard<TContext, TEvent> = (args) => boolean;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/types.ts#L13)
|
|
10
10
|
|
|
11
11
|
Standard XState guard function signature
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/guards/types.ts#L23)
|
|
10
10
|
|
|
11
11
|
Array of guard predicates or guard names
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type PlayerFactory<TMachine> = (input?) => PlayerActor<TMachine>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/types.ts#L65)
|
|
10
10
|
|
|
11
11
|
Factory function returned by definePlayer()
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteMachineConfig = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L29)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:2
|
|
|
22
22
|
optional context?: unknown;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
25
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
|
|
|
32
32
|
optional on?: Record<string, unknown>;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L32)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
@@ -42,4 +42,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
|
|
|
42
42
|
optional states?: Record<string, unknown>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
45
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L31)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteStateNode = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
22
22
|
optional id?: string;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
25
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L14)
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
32
32
|
optional meta?: object;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
|
|
36
36
|
|
|
37
37
|
#### route?
|
|
38
38
|
|
|
@@ -48,4 +48,4 @@ optional route?: string;
|
|
|
48
48
|
optional states?: Record<string, RouteStateNode>;
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
51
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/routing/format-play-route-transitions.ts#L18)
|
|
@@ -14,4 +14,4 @@ type ValidationResult =
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
17
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L11)
|