@xmachines/docs 1.0.0-beta.44 → 1.0.0-beta.46

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 (429) hide show
  1. package/api/@xmachines/play/README.md +4 -4
  2. package/api/@xmachines/play/classes/NonNullableError.md +5 -5
  3. package/api/@xmachines/play/classes/PlayError.md +5 -5
  4. package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  6. package/api/@xmachines/play-actor/README.md +5 -5
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  14. package/api/@xmachines/play-dom/README.md +3 -2
  15. package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
  16. package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
  17. package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
  18. package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
  19. package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
  20. package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
  21. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
  22. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  29. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  30. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
  31. package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
  32. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
  33. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
  35. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
  37. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
  38. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
  40. package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
  41. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
  43. package/api/@xmachines/play-dom/variables/schema.md +2 -2
  44. package/api/@xmachines/play-dom-router/README.md +12 -11
  45. package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
  46. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
  47. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +2 -2
  48. package/api/@xmachines/play-dom-router/functions/createRouter.md +2 -2
  49. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
  51. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
  52. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  53. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +3 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
  58. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
  59. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
  60. package/api/@xmachines/play-react/README.md +9 -3
  61. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  62. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  63. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  65. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  66. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  69. package/api/@xmachines/play-react/functions/useActor.md +2 -2
  70. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  71. package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
  72. package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
  73. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  74. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
  75. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  76. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
  80. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  81. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +6 -6
  84. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  85. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
  87. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  88. package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
  89. package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
  90. package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
  91. package/api/@xmachines/play-react-router/README.md +12 -7
  92. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
  93. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  94. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
  95. package/api/@xmachines/play-react-router/functions/createRouteMap.md +2 -2
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +6 -6
  99. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +3 -3
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  102. package/api/@xmachines/play-router/README.md +5 -5
  103. package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
  104. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
  105. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
  106. package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
  107. package/api/@xmachines/play-router/functions/createRouteMap.md +2 -2
  108. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
  109. package/api/@xmachines/play-router/functions/createRouteMatcher.md +2 -2
  110. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
  111. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
  112. package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
  113. package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
  114. package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
  115. package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
  116. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
  117. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
  118. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +2 -2
  119. package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
  120. package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
  121. package/api/@xmachines/play-router/functions/routeExists.md +2 -2
  122. package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
  123. package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
  124. package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
  125. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
  126. package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
  127. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
  128. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
  129. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  130. package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
  131. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
  133. package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
  134. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +5 -5
  135. package/api/@xmachines/play-router/interfaces/RouteNode.md +11 -11
  136. package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
  137. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  138. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
  139. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  140. package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
  141. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
  142. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
  143. package/api/@xmachines/play-signals/README.md +1 -1
  144. package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
  145. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
  146. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
  147. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
  148. package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
  149. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
  150. package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
  151. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +1 -1
  152. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
  153. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  154. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
  155. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +1 -1
  156. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  167. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
  168. package/api/@xmachines/play-solid/README.md +10 -4
  169. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  170. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  172. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  173. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  176. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActor.md +2 -2
  179. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  183. package/api/@xmachines/play-solid/functions/usePlayView.md +2 -2
  184. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  188. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +9 -9
  190. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  191. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
  194. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  195. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +6 -6
  198. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  199. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
  201. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  204. package/api/@xmachines/play-solid/variables/ActorContext.md +2 -2
  205. package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
  206. package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
  207. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
  208. package/api/@xmachines/play-solid-router/README.md +16 -12
  209. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  210. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
  211. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
  212. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +2 -2
  213. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  214. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  215. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  216. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +3 -3
  217. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
  218. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  219. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
  220. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
  221. package/api/@xmachines/play-svelte/README.md +8 -2
  222. package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
  223. package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
  224. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +2 -2
  225. package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
  226. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +9 -9
  227. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  228. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  229. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +5 -5
  230. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +12 -12
  231. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
  232. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  233. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  234. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  235. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
  236. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  239. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  240. package/api/@xmachines/play-svelte-spa-router/README.md +6 -1
  241. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  242. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
  243. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +2 -2
  244. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
  245. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +3 -3
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
  251. package/api/@xmachines/play-sveltekit-router/README.md +7 -2
  252. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  253. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
  254. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +2 -2
  255. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
  256. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  258. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +3 -3
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
  261. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
  262. package/api/@xmachines/play-tanstack-react-router/README.md +14 -9
  263. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
  265. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
  266. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +2 -2
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
  268. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +6 -6
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +3 -3
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  275. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
  276. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  277. package/api/@xmachines/play-tanstack-solid-router/README.md +15 -10
  278. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  279. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +25 -25
  280. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
  281. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +2 -2
  282. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  283. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
  284. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +3 -3
  285. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
  286. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  287. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
  288. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
  289. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  290. package/api/@xmachines/play-vue/README.md +10 -5
  291. package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
  292. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
  293. package/api/@xmachines/play-vue/functions/useActor.md +2 -2
  294. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  295. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  296. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  297. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  298. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  299. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  300. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  301. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  302. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  303. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  304. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +6 -6
  305. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +2 -2
  306. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
  307. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  308. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
  309. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
  310. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +2 -2
  311. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  312. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  313. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  314. package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
  315. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  316. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  317. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  318. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  319. package/api/@xmachines/play-vue-router/README.md +16 -12
  320. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  321. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
  322. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +2 -2
  323. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  324. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +3 -3
  325. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  326. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  327. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
  328. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
  329. package/api/@xmachines/play-xstate/README.md +10 -10
  330. package/api/@xmachines/play-xstate/classes/PlayerActor.md +13 -13
  331. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
  332. package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
  333. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
  334. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +2 -2
  335. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  336. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  337. package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
  338. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
  339. package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
  340. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
  341. package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
  342. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  343. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
  344. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  345. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
  346. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
  347. package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
  348. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
  349. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
  350. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
  351. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
  352. package/api/@xmachines/shared/README.md +1 -1
  353. package/api/@xmachines/shared/vite-aliases/README.md +1 -1
  354. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  355. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
  356. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
  357. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
  358. package/api/@xmachines/shared/vitest/README.md +1 -1
  359. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
  360. package/examples/@xmachines/play-dom-demo/README.md +4 -4
  361. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
  362. package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
  363. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
  364. package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
  365. package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
  366. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
  367. package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
  368. package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
  369. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
  370. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
  371. package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
  372. package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
  373. package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
  374. package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
  375. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
  376. package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
  377. package/examples/@xmachines/play-react-demo/README.md +4 -4
  378. package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
  379. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
  380. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  381. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  382. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  383. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
  384. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  385. package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
  386. package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
  387. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
  388. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  389. package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
  390. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  391. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  392. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
  393. package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
  394. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
  395. package/examples/@xmachines/play-react-router-demo/README.md +4 -4
  396. package/examples/@xmachines/play-solid-demo/README.md +4 -4
  397. package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
  398. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
  399. package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
  400. package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
  401. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
  402. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
  403. package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
  404. package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
  405. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
  406. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
  407. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
  408. package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
  409. package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
  410. package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
  411. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
  412. package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
  413. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
  414. package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
  415. package/examples/@xmachines/play-svelte-demo/README.md +3 -3
  416. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  417. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
  418. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  419. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
  420. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
  421. package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
  422. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
  423. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
  424. package/examples/@xmachines/play-vue-demo/README.md +4 -4
  425. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
  426. package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
  427. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
  428. package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
  429. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / DomSchema
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / DomSchema
2
2
 
3
3
  # Type Alias: DomSchema
4
4
 
@@ -6,4 +6,4 @@
6
6
  type DomSchema = typeof schema;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom/src/json-render/schema.ts#L60)
9
+ Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom/src/json-render/schema.ts#L60)
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / MountFn
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / MountFn
2
2
 
3
3
  # Type Alias: MountFn
4
4
 
@@ -6,7 +6,7 @@
6
6
  type MountFn = (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom/src/create-play-ui.ts#L47)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom/src/create-play-ui.ts#L47)
10
10
 
11
11
  The mount function returned by createPlayUI.
12
12
  Call with (actor, container, mountOptions?) to start the renderer.
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / RenderErrorHandler
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / RenderErrorHandler
2
2
 
3
3
  # Type Alias: RenderErrorHandler
4
4
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / SetState
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / SetState
2
2
 
3
3
  # Type Alias: SetState
4
4
 
@@ -6,7 +6,7 @@
6
6
  type SetState = (updater) => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom/src/json-render/types.ts#L46)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom/src/json-render/types.ts#L46)
10
10
 
11
11
  Function to update the local state store.
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom](../README.md) / schema
1
+ [API](../../../README.md) / [@xmachines/play-dom](../README.md) / schema
2
2
 
3
3
  # Variable: schema
4
4
 
@@ -46,7 +46,7 @@ const schema: Schema<{
46
46
  }>;
47
47
  ```
48
48
 
49
- Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom/src/json-render/schema.ts#L20)
49
+ Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom/src/json-render/schema.ts#L20)
50
50
 
51
51
  The schema for @xmachines/play-dom
52
52
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../README.md) / @xmachines/play-dom-router
1
+ [API](../../README.md) / @xmachines/play-dom-router
2
2
 
3
3
  # @xmachines/play-dom-router
4
4
 
@@ -8,7 +8,7 @@ Browser History API wrapper, framework-agnostic router, and bidirectional actor
8
8
 
9
9
  ## Overview
10
10
 
11
- `@xmachines/play-dom-router` provides the **concrete browser implementations** intentionally separated from the environment-agnostic `@xmachines/play-router` core:
11
+ `@xmachines/play-dom-router` provides the **concrete browser implementations** intentionally separated from the environment-agnostic core:
12
12
 
13
13
  | Export | Description |
14
14
  | ------------------------------- | ------------------------------------------------------------------------------------------------------- |
@@ -17,14 +17,14 @@ Browser History API wrapper, framework-agnostic router, and bidirectional actor
17
17
  | `connectRouter(options)` | Bidirectional actor ↔ URL sync — history changes → `play.route`, `currentRoute` → `history.push` |
18
18
  | `createRouteMap(machine)` | Build a `RouteMap` from a machine's `meta.route` declarations |
19
19
 
20
- By keeping these in a dedicated package, server-side and non-browser environments can depend on `@xmachines/play-router` without pulling in any DOM APIs.
20
+ By keeping these in a dedicated package, server-side and non-browser environments can depend on without pulling in any DOM APIs.
21
21
 
22
22
  For JSX frameworks, use the framework adapters instead:
23
23
 
24
- - `@xmachines/play-react` + `@xmachines/play-react-router`
25
- - `@xmachines/play-vue` + `@xmachines/play-vue-router`
26
- - `@xmachines/play-solid` + `@xmachines/play-solid-router`
27
- - `@xmachines/play-svelte` + `@xmachines/play-sveltekit-router`
24
+ -
25
+ -
26
+ -
27
+ -
28
28
 
29
29
  ## Installation
30
30
 
@@ -144,7 +144,7 @@ disconnect();
144
144
 
145
145
  ### `createRouteMap(machine)`
146
146
 
147
- Builds a `RouteMap` from a machine's `meta.route` declarations. Re-exported from `@xmachines/play-router` for convenience.
147
+ Builds a `RouteMap` from a machine's `meta.route` declarations. Re-exported from for convenience.
148
148
 
149
149
  ```typescript
150
150
  const routeMap = createRouteMap(machine);
@@ -152,7 +152,7 @@ const routeMap = createRouteMap(machine);
152
152
  // Used by connectRouter to translate between actor state and browser URLs
153
153
  ```
154
154
 
155
- ## Pairing with `@xmachines/play-dom` (rendering)
155
+ ## Pairing with (rendering)
156
156
 
157
157
  Add declarative JSON-render view rendering on top of the routing layer:
158
158
 
@@ -240,8 +240,9 @@ interface BrowserHistory {
240
240
 
241
241
  ## Learn More
242
242
 
243
- - [Vanilla DOM renderer `@xmachines/play-dom`](../play-dom)
244
- - [Router core `@xmachines/play-router`](../play-router)
243
+ - [Demo](../../../examples/@xmachines/play-dom-router-demo/README.md)
244
+ - [Vanilla DOM renderer](../play-dom/README.md)
245
+ - [Router core](../play-router/README.md)
245
246
  - [Routing Patterns guide](../../packages/docs/examples/routing-patterns.md)
246
247
  - [Play RFC](../../packages/docs/rfc/play.md)
247
248
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / connectRouter
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / connectRouter
2
2
 
3
3
  # Function: connectRouter()
4
4
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L48)
9
+ Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L48)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createBrowserHistory
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createBrowserHistory
2
2
 
3
3
  # Function: createBrowserHistory()
4
4
 
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L120)
9
+ Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L120)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createRouteMap
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createRouteMap
2
2
 
3
3
  # Function: createRouteMap()
4
4
 
@@ -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:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createRouter
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / createRouter
2
2
 
3
3
  # Function: createRouter()
4
4
 
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-router.ts#L52)
9
+ Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-router.ts#L52)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
@@ -1,18 +1,18 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / BrowserHistory
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / BrowserHistory
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L1)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L26)
25
+ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L38)
39
+ Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L47)
61
+ Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L27)
81
+ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L25)
95
+ Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L15)
117
+ Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L20)
140
+ Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L33)
163
+ Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / BrowserWindow
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / BrowserWindow
2
2
 
3
3
  # Interface: BrowserWindow
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L59)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L59)
6
6
 
7
7
  Minimal window interface for createBrowserHistory
8
8
 
@@ -14,17 +14,17 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
14
14
 
15
15
  | Property | Modifier | Type | Defined in |
16
16
  | ----------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-history"></a> `history` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L60) |
18
- | `history.state` | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L61) |
19
- | `history.back` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L65) |
20
- | `history.forward` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L66) |
21
- | `history.go` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L64) |
22
- | `history.pushState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L62) |
23
- | `history.replaceState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L63) |
24
- | <a id="property-location"></a> `location` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L68) |
25
- | `location.hash` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L71) |
26
- | `location.pathname` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L69) |
27
- | `location.search` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L70) |
17
+ | <a id="property-history"></a> `history` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L60) |
18
+ | `history.state` | `readonly` | `unknown` | [play-dom-router/src/create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L61) |
19
+ | `history.back` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L65) |
20
+ | `history.forward` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L66) |
21
+ | `history.go` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L64) |
22
+ | `history.pushState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L62) |
23
+ | `history.replaceState` | `public` | `void` | [play-dom-router/src/create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L63) |
24
+ | <a id="property-location"></a> `location` | `public` | `object` | [play-dom-router/src/create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L68) |
25
+ | `location.hash` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L71) |
26
+ | `location.pathname` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L69) |
27
+ | `location.search` | `readonly` | `string` | [play-dom-router/src/create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L70) |
28
28
 
29
29
  ## Methods
30
30
 
@@ -34,7 +34,7 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
34
34
  addEventListener(type, listener): void;
35
35
  ```
36
36
 
37
- Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L73)
37
+ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L73)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -55,7 +55,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:73](https://gitlab.co
55
55
  removeEventListener(type, listener): void;
56
56
  ```
57
57
 
58
- Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-browser-history.ts#L74)
58
+ Defined in: [play-dom-router/src/create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-browser-history.ts#L74)
59
59
 
60
60
  #### Parameters
61
61
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / ConnectRouterOptions
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / ConnectRouterOptions
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-dom-router/src/connect-router.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L20)
5
+ Defined in: [play-dom-router/src/connect-router.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L20)
6
6
 
7
7
  Options for [connectRouter](../functions/connectRouter.md).
8
8
 
@@ -10,6 +10,6 @@ Options for [connectRouter](../functions/connectRouter.md).
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | The actor to synchronize with the browser URL. Must implement `Routable`. | [play-dom-router/src/connect-router.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L22) |
14
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | Route lookup used to match URL pathnames to machine state IDs. | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L26) |
15
- | <a id="property-router"></a> `router` | `readonly` | [`VanillaRouter`](VanillaRouter.md) | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L24) |
13
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | The actor to synchronize with the browser URL. Must implement `Routable`. | [play-dom-router/src/connect-router.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L22) |
14
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteLookupContract`](RouteLookupContract.md) | Route lookup used to match URL pathnames to machine state IDs. | [play-dom-router/src/connect-router.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L26) |
15
+ | <a id="property-router"></a> `router` | `readonly` | [`VanillaRouter`](VanillaRouter.md) | The vanilla router created by [createRouter](../functions/createRouter.md). | [play-dom-router/src/connect-router.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L24) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / PlayRouteEvent
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / PlayRouteEvent
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L223)
5
+ Defined in: [play-router/src/types.ts:223](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L223)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L228) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L226) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L227) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L225) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L224) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L228) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L226) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L227) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L225) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L224) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteLookupContract
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteLookupContract
2
2
 
3
3
  # Interface: RouteLookupContract
4
4
 
5
- Defined in: [play-dom-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L12)
5
+ Defined in: [play-dom-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L12)
6
6
 
7
7
  Structural route lookup interface accepted by [connectRouter](../functions/connectRouter.md).
8
8
 
@@ -17,7 +17,7 @@ Any object with these two methods satisfies the constraint — including
17
17
  getPathByStateId(id): string | null | undefined;
18
18
  ```
19
19
 
20
- Defined in: [play-dom-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L14)
20
+ Defined in: [play-dom-router/src/connect-router.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L14)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -37,7 +37,7 @@ Defined in: [play-dom-router/src/connect-router.ts:14](https://gitlab.com/xmachi
37
37
  getStateIdByPath(path): string | null | undefined;
38
38
  ```
39
39
 
40
- Defined in: [play-dom-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/connect-router.ts#L13)
40
+ Defined in: [play-dom-router/src/connect-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/connect-router.ts#L13)
41
41
 
42
42
  #### Parameters
43
43
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMap
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMap
2
2
 
3
3
  # Interface: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L100)
5
+ Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
50
50
  getPathByStateId(stateId): string | null;
51
51
  ```
52
52
 
53
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L209)
53
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L209)
54
54
 
55
55
  Look up the path pattern registered for a state ID.
56
56
 
@@ -81,7 +81,7 @@ map.getPathByStateId("missing"); // null
81
81
  getStateIdByPath(path): string | null;
82
82
  ```
83
83
 
84
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L174)
84
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L174)
85
85
 
86
86
  Resolve a URL path to its mapped state ID.
87
87
 
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMapOptions
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMapOptions
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/v1.0.0-beta.44/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/v1.0.0-beta.46/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/create-route-map.ts#L20) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMapping
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouteMapping
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L57)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L61) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L59) |
@@ -1,8 +1,8 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouterBridge
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RouterBridge
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L271)
5
+ Defined in: [play-router/src/types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L271)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L287)
57
+ Defined in: [play-router/src/types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L287)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-router/src/types.ts#L303)
86
+ Defined in: [play-router/src/types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/types.ts#L303)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -1,15 +1,15 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / VanillaRouter
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / VanillaRouter
2
2
 
3
3
  # Interface: VanillaRouter
4
4
 
5
- Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-router.ts#L4)
5
+ Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-router.ts#L4)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------- | ---------- | -------------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-router.ts#L8) |
12
- | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | Route tree (for structure reference) | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-router.ts#L13) |
11
+ | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [play-dom-router/src/create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-router.ts#L8) |
12
+ | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](../../play-router/interfaces/RouteTree.md) | Route tree (for structure reference) | [play-dom-router/src/create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-router.ts#L13) |
13
13
 
14
14
  ## Methods
15
15
 
@@ -19,7 +19,7 @@ Defined in: [play-dom-router/src/create-router.ts:4](https://gitlab.com/xmachin-
19
19
  destroy(): void;
20
20
  ```
21
21
 
22
- Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/create-router.ts#L18)
22
+ Defined in: [play-dom-router/src/create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/create-router.ts#L18)
23
23
 
24
24
  Cleanup
25
25
 
@@ -1,4 +1,4 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RoutableActor
1
+ [API](../../../README.md) / [@xmachines/play-dom-router](../README.md) / RoutableActor
2
2
 
3
3
  # Type Alias: RoutableActor
4
4
 
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.44/packages/play-dom-router/src/types.ts#L9)
9
+ Defined in: [play-dom-router/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-dom-router/src/types.ts#L9)