@xmachines/docs 1.0.0-beta.15 → 1.0.0-beta.16
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 +48 -37
- 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 +12 -38
- 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 +7 -7
- 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 +32 -26
- 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/namespaces/Signal/classes/Computed.md +3 -9
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +3 -11
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +5 -7
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +3 -13
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +0 -2
- 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/AbstractActor.md +48 -35
- 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 +11 -11
- 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/README.md +19 -1
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +63 -44
- 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/PlayerFactoryResumeOptions.md +22 -0
- 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 +6 -5
- 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/examples/README.md +20 -6
- package/examples/multi-router-integration.md +2 -5
- package/examples/routing-patterns.md +2 -3
- package/package.json +3 -3
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: VueBaseRouteMap
|
|
4
4
|
|
|
5
|
-
Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-base-route-map.ts#L28)
|
|
6
6
|
|
|
7
7
|
VueBaseRouteMap — intermediate base class for Vue Router adapters.
|
|
8
8
|
|
|
@@ -44,7 +44,7 @@ class MyVueRouteMap extends VueBaseRouteMap {
|
|
|
44
44
|
new VueBaseRouteMap(mappings): VueBaseRouteMap;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
47
|
+
Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-base-route-map.ts#L32)
|
|
48
48
|
|
|
49
49
|
#### Parameters
|
|
50
50
|
|
|
@@ -103,7 +103,7 @@ map.getPathByStateId("missing"); // null
|
|
|
103
103
|
getPattern(stateId): string | undefined;
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
106
|
+
Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-base-route-map.ts#L58)
|
|
107
107
|
|
|
108
108
|
Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
|
|
109
109
|
|
|
@@ -125,7 +125,7 @@ Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
|
|
|
125
125
|
getRouteName(stateId): string | undefined;
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
-
Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
128
|
+
Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-base-route-map.ts#L48)
|
|
129
129
|
|
|
130
130
|
Get the Vue Router route name for a given state ID.
|
|
131
131
|
|
|
@@ -147,7 +147,7 @@ Get the Vue Router route name for a given state ID.
|
|
|
147
147
|
getStateId(routeName): string | undefined;
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
150
|
+
Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-base-route-map.ts#L53)
|
|
151
151
|
|
|
152
152
|
Get the state ID for a given Vue Router route name.
|
|
153
153
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: VueRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L32)
|
|
6
6
|
|
|
7
7
|
@xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
|
|
8
8
|
|
|
@@ -23,7 +23,7 @@ new VueRouterBridge(
|
|
|
23
23
|
vueRouteMap): VueRouterBridge;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
26
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L109)
|
|
27
27
|
|
|
28
28
|
Create a Vue Router bridge
|
|
29
29
|
|
|
@@ -73,7 +73,7 @@ onUnmounted(() => bridge.disconnect());
|
|
|
73
73
|
connect(): void;
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
76
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L229)
|
|
77
77
|
|
|
78
78
|
Override base class connect() to add Vue-native initial router → actor sync.
|
|
79
79
|
|
|
@@ -128,7 +128,7 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
128
128
|
dispose(): void;
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
131
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L275)
|
|
132
132
|
|
|
133
133
|
Cleanup alias for component lifecycle integration.
|
|
134
134
|
|
|
@@ -209,17 +209,17 @@ Extracted query parameters or empty object
|
|
|
209
209
|
### getInitialRouterPath()
|
|
210
210
|
|
|
211
211
|
```ts
|
|
212
|
-
protected getInitialRouterPath():
|
|
212
|
+
protected getInitialRouterPath(): undefined;
|
|
213
213
|
```
|
|
214
214
|
|
|
215
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
215
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L263)
|
|
216
216
|
|
|
217
|
-
Return
|
|
217
|
+
Return undefined to suppress base class initial sync — VueRouterBridge handles it
|
|
218
218
|
in connect() using the Vue-native named-route lookup instead.
|
|
219
219
|
|
|
220
220
|
#### Returns
|
|
221
221
|
|
|
222
|
-
`
|
|
222
|
+
`undefined`
|
|
223
223
|
|
|
224
224
|
#### Overrides
|
|
225
225
|
|
|
@@ -233,7 +233,7 @@ in connect() using the Vue-native named-route lookup instead.
|
|
|
233
233
|
protected navigateRouter(path): void;
|
|
234
234
|
```
|
|
235
235
|
|
|
236
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
236
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L126)
|
|
237
237
|
|
|
238
238
|
Navigate Vue Router to the given path/stateId.
|
|
239
239
|
|
|
@@ -321,7 +321,7 @@ Prevents circular updates via isProcessingNavigation flag.
|
|
|
321
321
|
protected unwatchRouterChanges(): void;
|
|
322
322
|
```
|
|
323
323
|
|
|
324
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
324
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L209)
|
|
325
325
|
|
|
326
326
|
Unsubscribe from Vue Router afterEach guard.
|
|
327
327
|
|
|
@@ -341,7 +341,7 @@ Unsubscribe from Vue Router afterEach guard.
|
|
|
341
341
|
protected watchRouterChanges(): void;
|
|
342
342
|
```
|
|
343
343
|
|
|
344
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
344
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/vue-router-bridge.ts#L150)
|
|
345
345
|
|
|
346
346
|
Subscribe to Vue Router changes using afterEach guard.
|
|
347
347
|
|
|
@@ -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/v1.0.0-beta.
|
|
9
|
+
Defined in: [play-vue-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
5
|
+
Defined in: [play-vue-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
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/v1.0.0-beta.
|
|
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/v1.0.0-beta.
|
|
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/v1.0.0-beta.16/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/v1.0.0-beta.16/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/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [play-vue-router/src/play-router-provider.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
67
|
+
Defined in: [play-vue-router/src/play-router-provider.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-vue-router/src/play-router-provider.ts#L11)
|
|
@@ -120,7 +120,7 @@ const createPlayer = definePlayer<TMachine, TCatalog>({
|
|
|
120
120
|
- `catalog` (optional) - UI component catalog with Zod schemas
|
|
121
121
|
- `options` (optional) - Lifecycle hooks
|
|
122
122
|
|
|
123
|
-
**Returns:** Factory function `(input?) => PlayerActor`
|
|
123
|
+
**Returns:** Factory function `(input?, { snapshot }?) => PlayerActor`
|
|
124
124
|
|
|
125
125
|
**Example:**
|
|
126
126
|
|
|
@@ -141,6 +141,22 @@ const actor2 = createPlayer({ userId: "user2" });
|
|
|
141
141
|
// Multiple independent actor instances
|
|
142
142
|
```
|
|
143
143
|
|
|
144
|
+
**Restoring from a snapshot:**
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
const createPlayer = definePlayer({ machine, catalog });
|
|
148
|
+
|
|
149
|
+
const actor = createPlayer({ userId: "user1" });
|
|
150
|
+
actor.start();
|
|
151
|
+
|
|
152
|
+
// ...persist the actor snapshot however your app stores it
|
|
153
|
+
const snapshot = actor.getSnapshot();
|
|
154
|
+
actor.stop();
|
|
155
|
+
|
|
156
|
+
const restoredActor = createPlayer({ userId: "user1" }, { snapshot });
|
|
157
|
+
restoredActor.start();
|
|
158
|
+
```
|
|
159
|
+
|
|
144
160
|
### PlayerActor
|
|
145
161
|
|
|
146
162
|
Concrete actor implementing Play signal protocol:
|
|
@@ -162,6 +178,7 @@ new PlayerActor(machine, catalog, options, input?)
|
|
|
162
178
|
```
|
|
163
179
|
|
|
164
180
|
- `input` — Typed as `InputFrom<TMachine>`. Consumers receive compile-time validation against the machine's input schema. Pass initial context values required by the machine.
|
|
181
|
+
- `snapshot` — Optional restored XState snapshot forwarded through `createPlayer(input?, { snapshot })` when you want to resume an actor instead of starting from the machine's initial state.
|
|
165
182
|
|
|
166
183
|
**Methods:**
|
|
167
184
|
|
|
@@ -479,6 +496,7 @@ reactivity.
|
|
|
479
496
|
|
|
480
497
|
- [CatalogEntry](interfaces/CatalogEntry.md)
|
|
481
498
|
- [PlayerConfig](interfaces/PlayerConfig.md)
|
|
499
|
+
- [PlayerFactoryResumeOptions](interfaces/PlayerFactoryResumeOptions.md)
|
|
482
500
|
- [PlayerOptions](interfaces/PlayerOptions.md)
|
|
483
501
|
- [RouteContext](interfaces/RouteContext.md)
|
|
484
502
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: PlayerActor\<TMachine\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
5
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L121)
|
|
6
6
|
|
|
7
7
|
Concrete XState actor implementing Play Architecture signal protocol
|
|
8
8
|
|
|
@@ -105,19 +105,21 @@ new PlayerActor<TMachine>(
|
|
|
105
105
|
machine,
|
|
106
106
|
catalog,
|
|
107
107
|
options,
|
|
108
|
-
input
|
|
108
|
+
input?,
|
|
109
|
+
snapshot?): PlayerActor<TMachine>;
|
|
109
110
|
```
|
|
110
111
|
|
|
111
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
112
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L143)
|
|
112
113
|
|
|
113
114
|
#### Parameters
|
|
114
115
|
|
|
115
|
-
| Parameter
|
|
116
|
-
|
|
|
117
|
-
| `machine`
|
|
118
|
-
| `catalog`
|
|
119
|
-
| `options`
|
|
120
|
-
| `input?`
|
|
116
|
+
| Parameter | Type |
|
|
117
|
+
| ----------- | --------------------------------------------------------------------------------- |
|
|
118
|
+
| `machine` | `TMachine` |
|
|
119
|
+
| `catalog` | [`Catalog`](../type-aliases/Catalog.md) \| `null` \| `undefined` |
|
|
120
|
+
| `options` | [`PlayerOptions`](../interfaces/PlayerOptions.md)\<`TMachine`\> |
|
|
121
|
+
| `input?` | [`InputFrom`](https://www.jsdocs.io/package/xstate#InputFrom)\<`TMachine`\> |
|
|
122
|
+
| `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> |
|
|
121
123
|
|
|
122
124
|
#### Returns
|
|
123
125
|
|
|
@@ -131,20 +133,20 @@ Defined in: [packages/play-xstate/src/player-actor.ts:142](https://gitlab.com/xm
|
|
|
131
133
|
|
|
132
134
|
| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
|
|
133
135
|
| ------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
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:
|
|
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) |
|
|
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
|
-
| <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
|
-
| <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) |
|
|
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) |
|
|
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) |
|
|
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) |
|
|
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) |
|
|
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) |
|
|
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:
|
|
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) |
|
|
147
|
-
| <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) |
|
|
136
|
+
| <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) | - |
|
|
137
|
+
| <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:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L141) |
|
|
138
|
+
| <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) | - |
|
|
139
|
+
| <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:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L139) |
|
|
140
|
+
| <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:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L140) |
|
|
141
|
+
| <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) | - |
|
|
142
|
+
| <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) | - |
|
|
143
|
+
| <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) | - |
|
|
144
|
+
| <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) | - |
|
|
145
|
+
| <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) | - |
|
|
146
|
+
| <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) | - |
|
|
147
|
+
| <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:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L138) |
|
|
148
|
+
| <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) | - |
|
|
149
|
+
| <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
|
|
148
150
|
|
|
149
151
|
## Methods
|
|
150
152
|
|
|
@@ -154,8 +156,6 @@ Defined in: [packages/play-xstate/src/player-actor.ts:142](https://gitlab.com/xm
|
|
|
154
156
|
observable: InteropSubscribable<any>;
|
|
155
157
|
```
|
|
156
158
|
|
|
157
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:153
|
|
158
|
-
|
|
159
159
|
#### Returns
|
|
160
160
|
|
|
161
161
|
[`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<`any`\>
|
|
@@ -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:
|
|
175
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L436)
|
|
176
176
|
|
|
177
177
|
Convenience dispose method for cleanup
|
|
178
178
|
|
|
@@ -190,8 +190,6 @@ Per CONTEXT.md: "Both .dispose() convenience method and manual machine.stop()"
|
|
|
190
190
|
getPersistedSnapshot(): Snapshot<unknown>;
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:152
|
|
194
|
-
|
|
195
193
|
Obtain the internal state of the actor, which can be persisted.
|
|
196
194
|
|
|
197
195
|
#### Returns
|
|
@@ -224,7 +222,7 @@ https://stately.ai/docs/persistence
|
|
|
224
222
|
getSnapshot(): SnapshotFrom<TMachine>;
|
|
225
223
|
```
|
|
226
224
|
|
|
227
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
225
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L309)
|
|
228
226
|
|
|
229
227
|
Get current snapshot
|
|
230
228
|
|
|
@@ -244,8 +242,6 @@ Get current snapshot
|
|
|
244
242
|
on<TType>(type, handler): Subscription;
|
|
245
243
|
```
|
|
246
244
|
|
|
247
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
|
|
248
|
-
|
|
249
245
|
#### Type Parameters
|
|
250
246
|
|
|
251
247
|
| Type Parameter |
|
|
@@ -269,13 +265,42 @@ Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
|
|
|
269
265
|
|
|
270
266
|
---
|
|
271
267
|
|
|
268
|
+
### select()
|
|
269
|
+
|
|
270
|
+
```ts
|
|
271
|
+
select<TSelected>(selector, equalityFn?): Readable<TSelected>;
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
#### Type Parameters
|
|
275
|
+
|
|
276
|
+
| Type Parameter |
|
|
277
|
+
| -------------- |
|
|
278
|
+
| `TSelected` |
|
|
279
|
+
|
|
280
|
+
#### Parameters
|
|
281
|
+
|
|
282
|
+
| Parameter | Type |
|
|
283
|
+
| ------------- | --------------------------- |
|
|
284
|
+
| `selector` | (`snapshot`) => `TSelected` |
|
|
285
|
+
| `equalityFn?` | (`a`, `b`) => `boolean` |
|
|
286
|
+
|
|
287
|
+
#### Returns
|
|
288
|
+
|
|
289
|
+
`Readable`\<`TSelected`\>
|
|
290
|
+
|
|
291
|
+
#### Inherited from
|
|
292
|
+
|
|
293
|
+
[`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`select`](../../play-actor/classes/AbstractActor.md#select)
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
272
297
|
### send()
|
|
273
298
|
|
|
274
299
|
```ts
|
|
275
300
|
send(event): void;
|
|
276
301
|
```
|
|
277
302
|
|
|
278
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
303
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:284](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L284)
|
|
279
304
|
|
|
280
305
|
Send event to actor
|
|
281
306
|
|
|
@@ -314,7 +339,7 @@ actor.send({ type: "play.route", to: "#home" });
|
|
|
314
339
|
start(): this;
|
|
315
340
|
```
|
|
316
341
|
|
|
317
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
342
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L241)
|
|
318
343
|
|
|
319
344
|
Start the actor
|
|
320
345
|
|
|
@@ -336,7 +361,7 @@ Per RESEARCH.md Pitfall 1: Always call start() after creation
|
|
|
336
361
|
stop(): this;
|
|
337
362
|
```
|
|
338
363
|
|
|
339
|
-
Defined in: [packages/play-xstate/src/player-actor.ts:
|
|
364
|
+
Defined in: [packages/play-xstate/src/player-actor.ts:255](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/player-actor.ts#L255)
|
|
340
365
|
|
|
341
366
|
Stop the actor and cleanup
|
|
342
367
|
|
|
@@ -358,8 +383,6 @@ Stop the actor and cleanup
|
|
|
358
383
|
subscribe(observer): Subscription;
|
|
359
384
|
```
|
|
360
385
|
|
|
361
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:113
|
|
362
|
-
|
|
363
386
|
Subscribe an observer to an actor’s snapshot values.
|
|
364
387
|
|
|
365
388
|
##### Parameters
|
|
@@ -434,8 +457,6 @@ subscribe(
|
|
|
434
457
|
completeListener?): Subscription;
|
|
435
458
|
```
|
|
436
459
|
|
|
437
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:114
|
|
438
|
-
|
|
439
460
|
Subscribe an observer to an actor’s snapshot values.
|
|
440
461
|
|
|
441
462
|
##### Parameters
|
|
@@ -511,16 +532,14 @@ unsubscribed.
|
|
|
511
532
|
toJSON(): object;
|
|
512
533
|
```
|
|
513
534
|
|
|
514
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:135
|
|
515
|
-
|
|
516
535
|
#### Returns
|
|
517
536
|
|
|
518
537
|
`object`
|
|
519
538
|
|
|
520
|
-
| Name | Type | Defined in
|
|
521
|
-
| -------------- | -------- |
|
|
522
|
-
| `id` | `string` |
|
|
523
|
-
| `xstate$$type` | `number` |
|
|
539
|
+
| Name | Type | Defined in |
|
|
540
|
+
| -------------- | -------- | ---------- |
|
|
541
|
+
| `id` | `string` | - |
|
|
542
|
+
| `xstate$$type` | `number` | - |
|
|
524
543
|
|
|
525
544
|
#### Inherited from
|
|
526
545
|
|
|
@@ -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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/build-url.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/compose.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/define-player.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/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/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-xstate/src/catalog/validate-props.ts#L115)
|
|
10
10
|
|
|
11
11
|
Merge view metadata with context for props
|
|
12
12
|
|