@xmachines/docs 2.1.0 → 2.1.1

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.
Files changed (295) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/README.md +1 -1
  3. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  4. package/api/@xmachines/play/classes/PlayError.md +4 -4
  5. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  6. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  7. package/api/@xmachines/play-actor/README.md +1 -1
  8. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  9. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  10. package/api/@xmachines/play-actor/functions/composePlayState.md +1 -1
  11. package/api/@xmachines/play-actor/functions/createViewStoreLifecycle.md +1 -1
  12. package/api/@xmachines/play-actor/functions/guardContextWrites.md +1 -1
  13. package/api/@xmachines/play-actor/functions/refreshContextSubtree.md +1 -1
  14. package/api/@xmachines/play-actor/functions/reuseComposedState.md +1 -1
  15. package/api/@xmachines/play-actor/functions/shallowEqualExcept.md +1 -1
  16. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  17. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  18. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  19. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  20. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  21. package/api/@xmachines/play-actor/interfaces/ResolveViewStoreOptions.md +2 -2
  22. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  23. package/api/@xmachines/play-actor/interfaces/ViewStoreLifecycle.md +3 -3
  24. package/api/@xmachines/play-actor/interfaces/ViewStoreResolution.md +4 -4
  25. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  26. package/api/@xmachines/play-actor/variables/CONTEXT_STATE_KEY.md +1 -1
  27. package/api/@xmachines/play-dom/README.md +1 -1
  28. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  29. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  30. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  31. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +2 -2
  32. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  33. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +4 -4
  34. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  35. package/api/@xmachines/play-dom-router/README.md +1 -1
  36. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +4 -4
  37. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  38. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  39. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  41. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  42. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  43. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  44. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  45. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  46. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  47. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  48. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  52. package/api/@xmachines/play-react/README.md +1 -1
  53. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  54. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  55. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  56. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  57. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  58. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  59. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  60. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  61. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  62. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  63. package/api/@xmachines/play-react/type-aliases/PlayRendererProps.md +1 -1
  64. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  65. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  66. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  67. package/api/@xmachines/play-react-router/README.md +1 -1
  68. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -4
  69. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  70. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  71. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  72. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  73. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  74. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  75. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  77. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  78. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  79. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  81. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  82. package/api/@xmachines/play-router/README.md +1 -1
  83. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  84. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -4
  85. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  86. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  87. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  88. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  89. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  91. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  92. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  93. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  94. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  95. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  96. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  97. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  99. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  100. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  101. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  102. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  103. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  104. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  105. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  107. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  108. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  109. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  110. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  112. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  113. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  114. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  115. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  116. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  117. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  118. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  119. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  120. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  121. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  122. package/api/@xmachines/play-router/type-aliases/BaseRouteMapping.md +1 -1
  123. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  124. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  125. package/api/@xmachines/play-signals/README.md +1 -1
  126. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  127. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  130. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  131. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  132. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  133. package/api/@xmachines/play-solid/README.md +1 -1
  134. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  135. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  136. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  137. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  138. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  139. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  140. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  141. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  142. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  143. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  144. package/api/@xmachines/play-solid-router/README.md +1 -1
  145. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  146. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -5
  147. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  148. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  149. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  150. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  152. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  153. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  154. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  155. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  156. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  157. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  158. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  159. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  160. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  161. package/api/@xmachines/play-svelte/README.md +1 -1
  162. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  163. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  164. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  165. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  166. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  167. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  168. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  169. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  170. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  171. package/api/@xmachines/play-svelte-spa-router/README.md +1 -1
  172. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  173. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +4 -4
  174. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  175. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  176. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  177. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  178. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  179. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  180. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  181. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  182. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  183. package/api/@xmachines/play-sveltekit-router/README.md +1 -1
  184. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  185. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +4 -4
  186. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  187. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  188. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  189. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  190. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  191. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  192. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  193. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  194. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  195. package/api/@xmachines/play-tanstack-react-router/README.md +2 -1
  196. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  197. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -4
  198. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  199. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  200. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  201. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  202. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  203. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  204. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  205. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  206. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  207. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  208. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  209. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  210. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  211. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  212. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +59 -11
  213. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  214. package/api/@xmachines/play-tanstack-router/README.md +19 -1
  215. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -2
  216. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  217. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +59 -11
  218. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -1
  219. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  220. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -5
  221. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  222. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  223. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  224. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  225. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  226. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  227. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  228. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  229. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  230. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  231. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  232. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  233. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +59 -11
  234. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  235. package/api/@xmachines/play-vue/README.md +1 -1
  236. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  237. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  238. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  239. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  240. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  241. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  243. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  244. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  245. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  246. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  247. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  248. package/api/@xmachines/play-vue/variables/getPlayViewContext.md +1 -1
  249. package/api/@xmachines/play-vue-router/README.md +1 -1
  250. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  251. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -5
  252. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  253. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  254. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  255. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  256. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  257. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  258. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  259. package/api/@xmachines/play-vue-router/type-aliases/VueRouteMap.md +1 -1
  260. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  261. package/api/@xmachines/play-vue-router/variables/VueRouteMap.md +1 -1
  262. package/api/@xmachines/play-xstate/README.md +1 -1
  263. package/api/@xmachines/play-xstate/classes/PlayerActor.md +16 -16
  264. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  265. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  266. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  267. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  268. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  269. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  270. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  271. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  272. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  273. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  274. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  275. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  276. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  277. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  278. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  279. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  280. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  281. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  282. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  283. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  284. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  285. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  286. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  287. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  288. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  289. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  290. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  291. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  292. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  293. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  294. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  295. package/package.json +1 -1
package/api/@xmachines/play-vue-router/interfaces/PlayActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:312](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L312)
5
+ Defined in: [play-router/src/types.ts:312](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L312)
6
6
 
7
7
  The complete actor shape of the `PlayRouterProvider` component of each framework
8
8
  adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
@@ -39,9 +39,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
39
39
 
40
40
  | Property | Modifier | Type | Description | Inherited from | Defined in |
41
41
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
42
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:274](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L274) |
43
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active. | - | [play-router/src/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L314) |
44
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L280) |
42
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:274](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L274) |
43
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active. | - | [play-router/src/types.ts:314](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L314) |
44
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L280) |
45
45
 
46
46
  ## Methods
47
47
 
@@ -51,7 +51,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
51
51
  send(event): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L282)
54
+ Defined in: [play-router/src/types.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L282)
55
55
 
56
56
  Sends a route navigation event to the actor.
57
57
 
package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L237)
5
+ Defined in: [play-router/src/types.ts:237](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L237)
6
6
 
7
7
  The routing event, with its parameters and its query
8
8
 
@@ -128,8 +128,8 @@ analysis of the pattern.
128
128
 
129
129
  | Property | Modifier | Type | Defined in |
130
130
  | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
131
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L242) |
132
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L240) |
133
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L241) |
134
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L239) |
135
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L238) |
131
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L242) |
132
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L240) |
133
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L241) |
134
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L239) |
135
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L238) |
package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  The options of `createRouteMap` and of `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | The maximum number of the resolved parameterized path lookups in the cache. `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example `/profile/:userId`, with URLPattern on each call. The map keeps each path of a frequent visit in an LRU cache, and a later lookup of that path is therefore O(1). Raise this value for an application with a large set of parameterized routes, or with a high frequency of the navigation. The default is `500`. | [play-router/src/create-route-map.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map.ts#L21) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | The maximum number of the resolved parameterized path lookups in the cache. `RouteMap.getStateIdByPath()` resolves a parameterized pattern, for example `/profile/:userId`, with URLPattern on each call. The map keeps each path of a frequent visit in an LRU cache, and a later lookup of that path is therefore O(1). Raise this value for an application with a large set of parameterized routes, or with a high frequency of the navigation. The default is `500`. | [play-router/src/create-route-map.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L21) |
package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L54)
5
+ Defined in: [play-router/src/base-route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L54)
6
6
 
7
7
  One entry of the map between a state ID and a path.
8
8
 
@@ -24,5 +24,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
24
24
 
25
25
  | Property | Modifier | Type | Description | Defined in |
26
26
  | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
27
- | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L58) |
28
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L56) |
27
+ | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L58) |
28
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [play-router/src/base-route-map.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L56) |
package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L358)
5
+ Defined in: [play-router/src/types.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L358)
6
6
 
7
7
  The RouterBridge interface of a runtime infrastructure adapter
8
8
 
@@ -56,7 +56,7 @@ class MyRouterBridge implements RouterBridge {
56
56
  connect(): void | Promise<void>;
57
57
  ```
58
58
 
59
- Defined in: [play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L375)
59
+ Defined in: [play-router/src/types.ts:375](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L375)
60
60
 
61
61
  Connects the router bridge to the Actor
62
62
 
@@ -86,7 +86,7 @@ await bridge.connect();
86
86
  disconnect(): void | Promise<void>;
87
87
  ```
88
88
 
89
- Defined in: [play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/types.ts#L391)
89
+ Defined in: [play-router/src/types.ts:391](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/types.ts#L391)
90
90
 
91
91
  Disconnects the router bridge from the Actor
92
92
 
package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/play-router-provider.ts#L10)
9
+ Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/play-router-provider.ts#L10)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-vue-router/type-aliases/VueRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type VueRouteMap = RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/vue-base-route-map.ts#L8)
9
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/vue-base-route-map.ts#L8)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md CHANGED
@@ -64,7 +64,7 @@ const PlayRouterProvider: DefineComponent<
64
64
  >;
65
65
  ```
66
66
 
67
- Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/play-router-provider.ts#L19)
67
+ Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/play-router-provider.ts#L19)
68
68
 
69
69
  PlayRouterProvider — the Vue wrapper of VueRouterBridge.
70
70
 
package/api/@xmachines/play-vue-router/variables/VueRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const VueRouteMap: typeof RouteMap = RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/vue-base-route-map.ts#L8)
9
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/vue-base-route-map.ts#L8)
10
10
 
11
11
  ## Deprecated
12
12
 
package/api/@xmachines/play-xstate/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > XState v5 adapter for the XMachines Play Architecture. It binds a state machine to the actor base, with signal-driven reactivity and a router integration.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.1.1-blue)](https://www.npmjs.com/package/@xmachines/play-xstate)
8
8
 
9
9
  ---
10
10
 
package/api/@xmachines/play-xstate/classes/PlayerActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayerActor\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/player-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L202)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L202)
6
6
 
7
7
  The concrete XState actor. It implements the signal protocol of the Play Architecture
8
8
 
@@ -122,7 +122,7 @@ new PlayerActor<TMachine>(
122
122
  restoredSnapshot?): PlayerActor<TMachine>;
123
123
  ```
124
124
 
125
- Defined in: [packages/play-xstate/src/player-actor.ts:360](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L360)
125
+ Defined in: [packages/play-xstate/src/player-actor.ts:360](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L360)
126
126
 
127
127
  #### Parameters
128
128
 
@@ -147,16 +147,16 @@ Defined in: [packages/play-xstate/src/player-actor.ts:360](https://gitlab.com/xm
147
147
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
148
148
  | <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) | - |
149
149
  | <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) | - |
150
- | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed`. It derives the current URL path from the `meta.route` template of the active machine state and from the context of the actor. It returns `null` when the current state has no `meta.route` field, and also when it cannot resolve the complete route template. A necessary `:param` that the context does not hold is caught inside the signal, and a `MissingRouteParamError` therefore never leaves `get()`: that condition is temporary during a transition, and the signal computes the value again on the next snapshot. **Example** `// It returns "/profile/alice" when context.params.userId === "alice", // and null while the param is still absent. const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:304](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L304) |
151
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The reactive signal of the current view spec. The signal derives the spec from the `meta.view` metadata of the active state. It emits a **new object reference** on each real change of the view on the screen: the view of a different state, or a change of a param or of the context that changes the resolved spec. A re-entry with `reenter: true` and new params also changes the spec. A snapshot that changes no view on the screen, such as an assign of the context alone, keeps the previous reference. A provider below the signal therefore mounts the UI again not on every event. The `PlaySpec` of the emission carries the context of the machine in its composed `state` field, under the read-only `/context` subtree. A spec therefore reads the context, and also each URL param, through the ordinary state grammar (`{ $state: "/context/params/section" }`). The context-projection module of `@xmachines/play-actor` holds the complete contract. The signal returns `null` when the current state has no `meta.view` metadata. Two states can declare two separate `meta.view` literals with an identical structure. A transition between those two states then emits two different references, and a provider mounts the UI again. Move the shared literal into one `typedSpec` constant, and the identity then removes the duplicate. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.root); // for example "root" console.log(view.elements); // the Spec elements of @xmachines/json-render-core }` | - | - | [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L358) |
150
+ | <a id="property-currentroute"></a> `currentRoute` | `public` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | A TC39 `Signal.Computed`. It derives the current URL path from the `meta.route` template of the active machine state and from the context of the actor. It returns `null` when the current state has no `meta.route` field, and also when it cannot resolve the complete route template. A necessary `:param` that the context does not hold is caught inside the signal, and a `MissingRouteParamError` therefore never leaves `get()`: that condition is temporary during a transition, and the signal computes the value again on the next snapshot. **Example** `// It returns "/profile/alice" when context.params.userId === "alice", // and null while the param is still absent. const route = actor.currentRoute.get();` | - | - | [packages/play-xstate/src/player-actor.ts:304](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L304) |
151
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The reactive signal of the current view spec. The signal derives the spec from the `meta.view` metadata of the active state. It emits a **new object reference** on each real change of the view on the screen: the view of a different state, or a change of a param or of the context that changes the resolved spec. A re-entry with `reenter: true` and new params also changes the spec. A snapshot that changes no view on the screen, such as an assign of the context alone, keeps the previous reference. A provider below the signal therefore mounts the UI again not on every event. The `PlaySpec` of the emission carries the context of the machine in its composed `state` field, under the read-only `/context` subtree. A spec therefore reads the context, and also each URL param, through the ordinary state grammar (`{ $state: "/context/params/section" }`). The context-projection module of `@xmachines/play-actor` holds the complete contract. The signal returns `null` when the current state has no `meta.view` metadata. Two states can declare two separate `meta.view` literals with an identical structure. A transition between those two states then emits two different references, and a provider mounts the UI again. Move the shared literal into one `typedSpec` constant, and the identity then removes the duplicate. **Example** `const view = actor.currentView.get(); if (view) { console.log(view.root); // for example "root" console.log(view.elements); // the Spec elements of @xmachines/json-render-core }` | - | - | [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L358) |
152
152
  | <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) | - |
153
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it, and it never changes, also when the code restores the actor from a snapshot. A router bridge compares it with the browser URL, and it therefore separates a deep link (a URL that is not the initial one → the router wins) from a restore (the initial URL, and the actor at a different route from the restore → the actor wins). `deriveInitialRoute` derives the value statically from the machine definition, with the pure `initialTransition` helper of XState: the chain of the initial states and their `meta.route` templates are fixed at the moment of the machine definition, and the substitution of a `:param` uses the real initial context of the machine for the `input` of this actor. The code makes no second actor, and a snapshot of a restore changes the value never: it is always the **default** initial route of the machine. | - | - | [packages/play-xstate/src/player-actor.ts:323](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L323) |
153
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route of the initial state of the machine. The constructor fixes it, and it never changes, also when the code restores the actor from a snapshot. A router bridge compares it with the browser URL, and it therefore separates a deep link (a URL that is not the initial one → the router wins) from a restore (the initial URL, and the actor at a different route from the restore → the actor wins). `deriveInitialRoute` derives the value statically from the machine definition, with the pure `initialTransition` helper of XState: the chain of the initial states and their `meta.route` templates are fixed at the moment of the machine definition, and the substitution of a `:param` uses the real initial context of the machine for the `input` of this actor. The code makes no second actor, and a snapshot of a restore changes the value never: it is always the **default** initial route of the machine. | - | - | [packages/play-xstate/src/player-actor.ts:323](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L323) |
154
154
  | <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) | - |
155
155
  | <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) | - |
156
156
  | <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) | - |
157
157
  | <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) | - |
158
158
  | <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) | - |
159
- | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L263) |
159
+ | <a id="property-state"></a> `state` | `public` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | The reactive snapshot of the current actor state. The infrastructure observes this signal, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`state`](../../play-actor/classes/AbstractActor.md#property-state) | - | [packages/play-xstate/src/player-actor.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L263) |
160
160
  | <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) | - |
161
161
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | - | [`AbstractActor`](../../play-actor/classes/AbstractActor.md).[`systemId`](../../play-actor/classes/AbstractActor.md#property-systemid) | - |
162
162
 
@@ -186,7 +186,7 @@ Defined in: `xstate`
186
186
  can(event): boolean;
187
187
  ```
188
188
 
189
- Defined in: [packages/play-xstate/src/player-actor.ts:276](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L276)
189
+ Defined in: [packages/play-xstate/src/player-actor.ts:276](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L276)
190
190
 
191
191
  Tells you if the current state of the actor accepts the given event.
192
192
 
@@ -217,7 +217,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
217
217
  dispose(): void;
218
218
  ```
219
219
 
220
- Defined in: [packages/play-xstate/src/player-actor.ts:751](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L751)
220
+ Defined in: [packages/play-xstate/src/player-actor.ts:751](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L751)
221
221
 
222
222
  The dispose method, for the cleanup. It is the alias of [stop](#stop).
223
223
 
@@ -237,7 +237,7 @@ Use [stop](#stop). Will be removed in the next major.
237
237
  getPersistedSnapshot(options?): Snapshot<unknown>;
238
238
  ```
239
239
 
240
- Defined in: [packages/play-xstate/src/player-actor.ts:696](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L696)
240
+ Defined in: [packages/play-xstate/src/player-actor.ts:696](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L696)
241
241
 
242
242
  Returns the persisted snapshot of this actor.
243
243
 
@@ -266,7 +266,7 @@ Use it to serialize the state, and to restore it later with the
266
266
  getSnapshot(): SnapshotFrom<TMachine>;
267
267
  ```
268
268
 
269
- Defined in: [packages/play-xstate/src/player-actor.ts:595](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L595)
269
+ Defined in: [packages/play-xstate/src/player-actor.ts:595](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L595)
270
270
 
271
271
  Returns the current snapshot
272
272
 
@@ -286,7 +286,7 @@ Returns the current snapshot
286
286
  on<TType>(type, handler): Subscription;
287
287
  ```
288
288
 
289
- Defined in: [packages/play-xstate/src/player-actor.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L681)
289
+ Defined in: [packages/play-xstate/src/player-actor.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L681)
290
290
 
291
291
  Listens for the events that this actor emits with the `emit` action.
292
292
 
@@ -352,7 +352,7 @@ Defined in: `xstate`
352
352
  send(event): void;
353
353
  ```
354
354
 
355
- Defined in: [packages/play-xstate/src/player-actor.ts:556](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L556)
355
+ Defined in: [packages/play-xstate/src/player-actor.ts:556](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L556)
356
356
 
357
357
  Sends an event to this actor.
358
358
 
@@ -398,7 +398,7 @@ actor.send({ type: "play.route", to: "#home" });
398
398
  start(): this;
399
399
  ```
400
400
 
401
- Defined in: [packages/play-xstate/src/player-actor.ts:482](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L482)
401
+ Defined in: [packages/play-xstate/src/player-actor.ts:482](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L482)
402
402
 
403
403
  Starts the actor.
404
404
 
@@ -424,7 +424,7 @@ the side effects of `onStart` one time for one real start.
424
424
  stop(): this;
425
425
  ```
426
426
 
427
- Defined in: [packages/play-xstate/src/player-actor.ts:512](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L512)
427
+ Defined in: [packages/play-xstate/src/player-actor.ts:512](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L512)
428
428
 
429
429
  Stops the actor and cleans up.
430
430
 
@@ -453,7 +453,7 @@ fires `onStart` again.
453
453
  subscribe(observer): Subscription;
454
454
  ```
455
455
 
456
- Defined in: [packages/play-xstate/src/player-actor.ts:618](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L618)
456
+ Defined in: [packages/play-xstate/src/player-actor.ts:618](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L618)
457
457
 
458
458
  Subscribes to the snapshot updates of this actor.
459
459
 
@@ -484,7 +484,7 @@ subscribe(
484
484
  completeListener?): Subscription;
485
485
  ```
486
486
 
487
- Defined in: [packages/play-xstate/src/player-actor.ts:629](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/player-actor.ts#L629)
487
+ Defined in: [packages/play-xstate/src/player-actor.ts:629](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/player-actor.ts#L629)
488
488
 
489
489
  Subscribes to the snapshot updates of this actor.
490
490
 
package/api/@xmachines/play-xstate/functions/buildRouteUrl.md CHANGED
@@ -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:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/routing/build-url.ts#L38)
9
+ Defined in: [packages/play-xstate/src/routing/build-url.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/routing/build-url.ts#L38)
10
10
 
11
11
  Builds a complete URL from a route template and the context of the actor.
12
12
 
package/api/@xmachines/play-xstate/functions/composeGuards.md CHANGED
@@ -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:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/guards/compose.ts#L100)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/compose.ts#L100)
10
10
 
11
11
  Composes the guards with the AND logic, through the and() helper of XState
12
12
 
package/api/@xmachines/play-xstate/functions/composeGuardsOr.md CHANGED
@@ -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:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/guards/compose.ts#L159)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/compose.ts#L159)
10
10
 
11
11
  Composes the guards with the OR logic, through the or() helper of XState
12
12
 
package/api/@xmachines/play-xstate/functions/contextFieldMatches.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function contextFieldMatches<TContext>(fieldPath, expectedValue): 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/v2.1.0/packages/play-xstate/src/guards/helpers.ts#L75)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/helpers.ts#L75)
10
10
 
11
11
  Tells you if a context field holds the expected value.
12
12
 
package/api/@xmachines/play-xstate/functions/definePlayer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/define-player.ts#L61)
9
+ Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Creates a player factory from an XState machine
12
12
 
package/api/@xmachines/play-xstate/functions/deriveRoute.md CHANGED
@@ -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:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/routing/derive-route.ts#L92)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/routing/derive-route.ts#L92)
10
10
 
11
11
  Derives the route from the metadata of an XState state
12
12
 
package/api/@xmachines/play-xstate/functions/eventMatches.md CHANGED
@@ -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:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/guards/helpers.ts#L52)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/helpers.ts#L52)
10
10
 
11
11
  Tells you if the type of the event is the expected type
12
12
 
package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md CHANGED
@@ -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:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L112)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/routing/format-play-route-transitions.ts#L112)
10
10
 
11
11
  Makes the play.route transitions from the declarative route configs
12
12
 
package/api/@xmachines/play-xstate/functions/hasContext.md CHANGED
@@ -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:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/guards/helpers.ts#L24)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/helpers.ts#L24)
10
10
 
11
11
  Tells you if the context holds a value at the path, and that the value is truthy
12
12
 
package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md CHANGED
@@ -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:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/routing/derive-route.ts#L163)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/routing/derive-route.ts#L163)
10
10
 
11
11
  Tells you if the route path is absolute
12
12
 
package/api/@xmachines/play-xstate/functions/negateGuard.md CHANGED
@@ -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:215](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/guards/compose.ts#L215)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:215](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/guards/compose.ts#L215)
10
10
 
11
11
  Negates a guard, through the not() helper of XState
12
12
 
package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerConfig\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/types.ts#L7)
5
+ Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  The configuration of definePlayer()
8
8
 
@@ -16,5 +16,5 @@ The configuration of definePlayer()
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ---------------------------------------- | ------------------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-machine"></a> `machine` | `TMachine` | The XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/types.ts#L9) |
20
- | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | The lifecycle hooks and the configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/types.ts#L12) |
19
+ | <a id="property-machine"></a> `machine` | `TMachine` | The XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/types.ts#L9) |
20
+ | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | The lifecycle hooks and the configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/types.ts#L12) |
package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerFactoryResumeOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/types.ts#L115)
5
+ Defined in: [packages/play-xstate/src/types.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/types.ts#L115)
6
6
 
7
7
  The optional restore arguments of the player factory.
8
8
 
@@ -19,4 +19,4 @@ The shape follows the options object of `createActor` in XState. It also keeps t
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ------------------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-snapshot"></a> `snapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\> | The persisted XState snapshot. The factory restores the actor state from it. Its type is the `ActorOptions["snapshot"]` type of XState, which is the exact type that `createActor` accepts and that `getPersistedSnapshot()` returns. The restore of a stored snapshot therefore needs no cast. | [packages/play-xstate/src/types.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-xstate/src/types.ts#L123) |
22
+ | <a id="property-snapshot"></a> `snapshot?` | [`Snapshot`](https://www.jsdocs.io/package/xstate#Snapshot)\<`unknown`\> | The persisted XState snapshot. The factory restores the actor state from it. Its type is the `ActorOptions["snapshot"]` type of XState, which is the exact type that `createActor` accepts and that `getPersistedSnapshot()` returns. The restore of a stored snapshot therefore needs no cast. | [packages/play-xstate/src/types.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-xstate/src/types.ts#L123) |