@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
@@ -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) |
@@ -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) |
@@ -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
 
@@ -6,7 +6,7 @@
6
6
  type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L32)
9
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L32)
10
10
 
11
11
  The constructor shape that a bridge class must satisfy for
12
12
  `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)
10
10
 
11
11
  ## Deprecated
12
12
 
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof TanStackSolidRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L23)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L23)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L38)
10
10
 
11
11
  The type-only interface of the TanStack Router surface that
12
12
  `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L46)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L71)
24
24
 
25
25
  #### location
26
26
 
@@ -61,6 +61,40 @@ subscribe(handler): () => void;
61
61
 
62
62
  () => `void`
63
63
 
64
+ ---
65
+
66
+ ### options?
67
+
68
+ ```ts
69
+ optional options?: object;
70
+ ```
71
+
72
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L57)
73
+
74
+ The options of the router. The bridge reads `parseSearch` only.
75
+
76
+ TanStack owns the encoding of a query: its default `stringifySearch` writes each
77
+ value through `JSON.stringify`, so a plain string arrives in the URL with quotes
78
+ around it. `parseSearch` is the inverse, and it is therefore the only correct way
79
+ to turn a query string of the URL into the `search` object that `navigate`
80
+ accepts. A router double may hold neither.
81
+
82
+ #### parseSearch()?
83
+
84
+ ```ts
85
+ optional parseSearch(search): Record<string, unknown>;
86
+ ```
87
+
88
+ ##### Parameters
89
+
90
+ | Parameter | Type |
91
+ | --------- | -------- |
92
+ | `search` | `string` |
93
+
94
+ ##### Returns
95
+
96
+ `Record`\<`string`, `unknown`\>
97
+
64
98
  ## Methods
65
99
 
66
100
  ### load()?
@@ -69,12 +103,18 @@ subscribe(handler): () => void;
69
103
  optional load(): void | Promise<void>;
70
104
  ```
71
105
 
72
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L45)
106
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L70)
73
107
 
74
108
  Runs the TanStack route matching and the loaders again for the current location.
75
- This method is optional. The bridge calls it after every navigation, and it does
76
- not wait for the result. The matching and the loaders therefore stay correct,
77
- also when no `<RouterProvider>` is mounted.
109
+ This method is optional. The bridge calls it after every navigation. The matching
110
+ and the loaders therefore stay correct, also when no `<RouterProvider>` is
111
+ mounted.
112
+
113
+ The real implementation returns a promise. `watchRouterChanges` waits for that
114
+ promise before it synchronizes the actor, because `router.load()` is the only
115
+ public point that also runs `router.updateLatestLocation()`. See
116
+ `watchRouterChanges` for the reason. A test double may return `void`, and the
117
+ bridge then synchronizes synchronously.
78
118
 
79
119
  #### Returns
80
120
 
@@ -88,14 +128,22 @@ also when no `<RouterProvider>` is mounted.
88
128
  navigate(args): void;
89
129
  ```
90
130
 
91
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L38)
131
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L47)
132
+
133
+ Navigates to a location. `search` carries the query of the target.
134
+
135
+ The bridge passes `search` whenever the route of the actor holds a query. A
136
+ `navigate({ to })` call with no `search` makes TanStack rebuild the query from
137
+ `validateSearch({})` of the matched route, and a route that injects a default
138
+ then commits a different href than the bridge asked for.
92
139
 
93
140
  #### Parameters
94
141
 
95
- | Parameter | Type |
96
- | --------- | --------------------- |
97
- | `args` | \{ `to`: `string`; \} |
98
- | `args.to` | `string` |
142
+ | Parameter | Type |
143
+ | -------------- | ----------------------------------------------------------------- |
144
+ | `args` | \{ `search?`: `Record`\<`string`, `unknown`\>; `to`: `string`; \} |
145
+ | `args.search?` | `Record`\<`string`, `unknown`\> |
146
+ | `args.to` | `string` |
99
147
 
100
148
  #### Returns
101
149
 
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L43)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L43)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack Solid Router. It keeps the actor state and the
12
12
  browser URL in step, in both directions.
@@ -4,7 +4,7 @@
4
4
 
5
5
  > Vue 3 renderer for the XMachines Play Architecture. It observes the actor signals and renders the UI through `@xmachines/json-render-vue`.
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-vue)
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-vue)
8
8
 
9
9
  ---
10
10
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/define-registry.ts#L138)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/define-registry.ts#L138)
10
10
 
11
11
  Creates a component registry. It wraps each `.vue` SFC, so that the SFC works
12
12
  correctly with the render pipeline of `@xmachines/json-render-vue`.
@@ -6,7 +6,7 @@
6
6
  function useActor(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/useActor.ts#L64)
9
+ Defined in: [packages/play-vue/src/useActor.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/useActor.ts#L64)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,7 +6,7 @@
6
6
  function usePlayView(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/actor-provider-context.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/actor-provider-context.ts#L46)
9
+ Defined in: [packages/play-vue/src/actor-provider-context.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/actor-provider-context.ts#L46)
10
10
 
11
11
  Returns the current ViewContextValue inside an ActorProvider tree.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-vue/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L15)
5
+ Defined in: [packages/play-vue/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L15)
6
6
 
7
7
  The props of the ActorProvider component.
8
8
  This file holds them, so that TypeScript can re-export them. The vue-shim has a
@@ -20,7 +20,7 @@ limit that stops a re-export from the .vue file.
20
20
 
21
21
  | Property | Type | Description | Inherited from | Defined in |
22
22
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
24
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
25
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
26
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
23
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L163) |
24
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L177) |
25
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L165) |
26
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L172) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayUIProviderProps
4
4
 
5
- Defined in: [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L29)
5
+ Defined in: [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L29)
6
6
 
7
7
  The props of the ActorProvider component.
8
8
  This file holds them, so that TypeScript can re-export them. The vue-shim has a
@@ -16,10 +16,10 @@ limit that stops a re-export from the .vue file.
16
16
 
17
17
  | Property | Type | Description | Inherited from | Defined in |
18
18
  | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
20
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, (`args?`, `state?`) => `unknown`\> | The named functions of a $computed expression in a prop | - | [packages/play-vue/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L38) |
21
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | The navigate function. The provider gives it to JSONUIProvider, which resolves each link with it | - | [packages/play-vue/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L31) |
22
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
23
- | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
24
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
25
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | The validation functions. The provider gives them to JSONUIProvider | - | [packages/play-vue/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L33) |
19
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | The actor instance with the currentView signal. It requires the Viewable capability. | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L163) |
20
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, (`args?`, `state?`) => `unknown`\> | The named functions of a $computed expression in a prop | - | [packages/play-vue/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L38) |
21
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | The navigate function. The provider gives it to JSONUIProvider, which resolves each link with it | - | [packages/play-vue/src/types.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L31) |
22
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L177) |
23
+ | <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L165) |
24
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L172) |
25
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | The validation functions. The provider gives them to JSONUIProvider | - | [packages/play-vue/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L33) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewContextValue
4
4
 
5
- Defined in: [packages/play-vue/src/actor-provider-context.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/actor-provider-context.ts#L23)
5
+ Defined in: [packages/play-vue/src/actor-provider-context.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/actor-provider-context.ts#L23)
6
6
 
7
7
  The context value that ActorProvider provides and PlayRenderer, the leaf without
8
8
  props, reads. usePlayView() gives it inside every ActorProvider tree and
@@ -16,7 +16,7 @@ PlayUIProvider tree.
16
16
 
17
17
  | Property | Type | Description | Inherited from | Defined in |
18
18
  | ----------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L127) |
20
- | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L129) |
21
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L125) |
22
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L133) |
19
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L127) |
20
+ | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L129) |
21
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L125) |
22
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-actor/src/abstract-actor.ts#L133) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # ~~Interface: VisibilityProviderProps~~
4
4
 
5
- Defined in: [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/types.ts#L27)
5
+ Defined in: [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/types.ts#L27)
6
6
 
7
7
  ## Deprecated
8
8
 
@@ -6,6 +6,6 @@
6
6
  type AnyPlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/useActor.ts#L46)
9
+ Defined in: [packages/play-vue/src/useActor.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/useActor.ts#L46)
10
10
 
11
11
  The bare actor type that the Vue context providers accept. For the complete routing and view shape, use `PlayActor` from `@xmachines/play-router`.
@@ -6,7 +6,7 @@
6
6
  type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/define-registry.ts#L111)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/define-registry.ts#L111)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/define-registry.ts#L115)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/define-registry.ts#L115)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
7
7
  object;
8
8
  ```
9
9
 
10
- Defined in: [packages/play-vue/src/define-registry.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/define-registry.ts#L119)
10
+ Defined in: [packages/play-vue/src/define-registry.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/define-registry.ts#L119)
11
11
 
12
12
  ## Type Declaration
13
13
 
14
14
  | Name | Type | Defined in |
15
15
  | ------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
16
- | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/define-registry.ts#L123) |
16
+ | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/define-registry.ts#L123) |
17
17
 
18
18
  ## Type Parameters
19
19
 
@@ -6,4 +6,4 @@
6
6
  const PlayRenderer: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/vue-shim.d.ts#L3)
9
+ Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/vue-shim.d.ts#L3)
@@ -6,7 +6,7 @@
6
6
  const getPlayViewContext: () => ViewContextValue = usePlayView;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/actor-provider-context.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue/src/actor-provider-context.ts#L55)
9
+ Defined in: [packages/play-vue/src/actor-provider-context.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue/src/actor-provider-context.ts#L55)
10
10
 
11
11
  Access the current ViewContextValue from inside an ActorProvider tree.
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Vue Router 4.x adapter for the XMachines Universal Player Architecture. It keeps Vue Router and an XMachines state machine in step, in both directions, with the reactive primitives of Vue.
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-vue-router)
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-vue-router)
8
8
 
9
9
  ## Installation
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L105)
5
+ Defined in: [play-router/src/base-route-map.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L105)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -58,7 +58,7 @@ map.getPathByStateId("missing"); // null
58
58
  new RouteMap(mappings, options?): RouteMap;
59
59
  ```
60
60
 
61
- Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L133)
61
+ Defined in: [play-router/src/base-route-map.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L133)
62
62
 
63
63
  Builds a route map from an array of the mappings between a state ID and a path.
64
64
 
@@ -87,7 +87,7 @@ candidates is therefore efficient.
87
87
  getPathByStateId(stateId): string | null;
88
88
  ```
89
89
 
90
- Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L225)
90
+ Defined in: [play-router/src/base-route-map.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L225)
91
91
 
92
92
  Returns the path pattern of a state ID.
93
93
 
@@ -123,7 +123,7 @@ map.getPathByStateId("missing"); // null
123
123
  getStateIdByPath(path): string | null;
124
124
  ```
125
125
 
126
- Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/base-route-map.ts#L185)
126
+ Defined in: [play-router/src/base-route-map.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/base-route-map.ts#L185)
127
127
 
128
128
  Resolves a URL path to its state ID.
129
129
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueRouterBridge
4
4
 
5
- Defined in: [play-vue-router/src/vue-router-bridge.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/vue-router-bridge.ts#L35)
5
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/vue-router-bridge.ts#L48)
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
  routeMap): VueRouterBridge;
24
24
  ```
25
25
 
26
- Defined in: [play-vue-router/src/vue-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/vue-router-bridge.ts#L44)
26
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/vue-router-bridge.ts#L57)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -49,7 +49,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:44](https://gitlab.com/xma
49
49
  connect(): void;
50
50
  ```
51
51
 
52
- Defined in: [play-router/src/router-bridge-base.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L158)
52
+ Defined in: [play-router/src/router-bridge-base.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/router-bridge-base.ts#L158)
53
53
 
54
54
  Connects the router bridge to the Actor.
55
55
 
@@ -83,7 +83,7 @@ An adapter that needs a different behavior of the first synchronization override
83
83
  disconnect(): void;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/router-bridge-base.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/router-bridge-base.ts#L270)
86
+ Defined in: [play-router/src/router-bridge-base.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/router-bridge-base.ts#L270)
87
87
 
88
88
  Disconnects the router bridge from the Actor.
89
89
 
@@ -106,7 +106,7 @@ framework.
106
106
  dispose(): void;
107
107
  ```
108
108
 
109
- Defined in: [play-vue-router/src/vue-router-bridge.ts:215](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-vue-router/src/vue-router-bridge.ts#L215)
109
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:259](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-vue-router/src/vue-router-bridge.ts#L259)
110
110
 
111
111
  The cleanup alias for the Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
112
112
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-router/src/create-route-map.ts#L47)
9
+ Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.1/packages/play-router/src/create-route-map.ts#L47)
10
10
 
11
11
  Creates a `RouteMap` from an XState state machine.
12
12