@xmachines/docs 1.0.0-beta.31 → 1.0.0-beta.32

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 (270) hide show
  1. package/api/@xmachines/play/README.md +5 -0
  2. package/api/@xmachines/play/classes/NonNullableError.md +189 -0
  3. package/api/@xmachines/play/classes/PlayError.md +9 -4
  4. package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +9 -9
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  12. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  13. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  14. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  16. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  17. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  18. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  19. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +3 -3
  20. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +3 -3
  21. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  22. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  23. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  24. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  25. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  26. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  27. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  28. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  31. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  32. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  33. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  34. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  35. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  36. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  37. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  38. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  39. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  40. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  41. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  42. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  43. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  44. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  45. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  46. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  47. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  48. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  49. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  50. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  51. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
  52. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  53. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  54. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  55. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  56. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  57. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  58. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  59. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  60. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-router/README.md +1 -1
  63. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  64. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  65. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  66. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  69. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  70. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  71. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  72. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  73. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  74. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  75. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  76. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  77. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  78. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  79. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  80. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  81. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  82. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  83. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  84. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  85. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  86. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  87. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  88. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  89. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  91. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  92. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  93. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  94. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  95. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  96. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  97. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  98. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  99. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  100. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  101. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  102. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  103. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  104. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  105. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  106. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  107. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  108. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  109. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  110. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  111. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  112. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  113. package/api/@xmachines/play-solid-router/README.md +2 -2
  114. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  115. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  116. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +28 -1
  117. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  118. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  119. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  120. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  121. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  124. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  125. package/api/@xmachines/play-svelte/README.md +8 -3
  126. package/api/@xmachines/play-svelte/functions/defineRegistry.md +12 -35
  127. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +23 -0
  128. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +6 -6
  129. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
  130. package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
  131. package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
  132. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  134. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  135. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  136. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  138. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  139. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  140. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  141. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  142. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  143. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  144. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  145. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  146. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  147. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  148. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  149. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  150. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  151. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  152. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +8 -1
  153. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  154. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  155. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  156. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  157. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  158. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  159. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  160. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  161. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  162. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  163. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  164. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  165. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +9 -1
  166. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  167. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  168. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  169. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  170. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  171. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  172. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  173. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  174. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  175. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  176. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +4 -4
  177. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  178. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  179. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  180. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  181. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  182. package/api/@xmachines/play-vue-router/README.md +3 -3
  183. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  184. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  185. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +39 -26
  186. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  187. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  188. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  190. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  192. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  193. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  195. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  196. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  199. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  200. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  201. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  202. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  203. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  204. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  205. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  206. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  207. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  208. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  209. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  210. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  211. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  212. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  213. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  214. package/api/@xmachines/shared/README.md +47 -47
  215. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  216. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  217. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  218. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  219. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  220. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  221. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  222. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  223. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  225. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  226. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  227. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  228. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  229. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  230. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  231. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  232. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  233. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  234. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  235. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  236. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  237. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  238. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  239. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  240. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  241. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  242. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  243. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  244. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  245. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  246. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  248. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  249. package/examples/@xmachines/play-react-router-demo/README.md +1 -3
  250. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  251. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  252. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  253. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  254. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  255. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  256. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  257. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  258. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  259. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  260. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  261. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  262. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  263. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  267. package/examples/@xmachines/play-solid-router-demo/README.md +1 -3
  268. package/examples/README.md +2 -2
  269. package/package.json +6 -6
  270. package/rfc/play.md +19 -19
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectRendererOptions
4
4
 
5
- Defined in: [xm-types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L38)
5
+ Defined in: [xm-types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L38)
6
6
 
7
7
  Options for connectRenderer() — backward compat API.
8
8
 
@@ -10,9 +10,9 @@ Options for connectRenderer() — backward compat API.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
- | <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) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L40) |
14
- | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L46) |
15
- | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing — clears container) | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L49) |
16
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L55) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L43) |
18
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L62) |
13
+ | <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) | Actor instance with currentView signal (requires Viewable capability) | [xm-types.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L40) |
14
+ | <a id="property-container"></a> `container` | `HTMLElement` | Container element to render into | [xm-types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L46) |
15
+ | <a id="property-fallback"></a> `fallback?` | `HTMLElement` \| `null` | Optional element shown when currentView is null (defaults to nothing — clears container) | [xm-types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L49) |
16
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L55) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | Registry of component renderers — replaces old `components` map | [xm-types.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L43) |
18
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored. When omitted, a fresh @xstate/store atom is created internally per view transition. | [xm-types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L62) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryOptions\<C\>
4
4
 
5
- Defined in: [json-render/types.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L144)
5
+ Defined in: [json-render/types.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L144)
6
6
 
7
7
  Options for `defineRegistry`.
8
8
 
@@ -19,5 +19,5 @@ Mirrors `DefineRegistryOptions<C>` from @json-render/react, /solid, /svelte, /vu
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ---------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Map of catalog action name → catalog-typed async handler function. Each handler receives params typed to the action's schema (or `undefined`). Guard against undefined before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: 'auth.login', username: params.username }); }, }` | [json-render/types.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L165) |
23
- | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. | [json-render/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L148) |
22
+ | <a id="property-actions"></a> `actions?` | [`Actions`](../type-aliases/Actions.md)\<`C`\> | Map of catalog action name → catalog-typed async handler function. Each handler receives params typed to the action's schema (or `undefined`). Guard against undefined before accessing params: **Example** `actions: { login: async (params) => { if (!params) return; actor.send({ type: 'auth.login', username: params.username }); }, }` | [json-render/types.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L165) |
23
+ | <a id="property-components"></a> `components?` | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. | [json-render/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L148) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: [json-render/types.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L174)
5
+ Defined in: [json-render/types.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L174)
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
@@ -13,5 +13,5 @@ returns `{ registry, handlers }` instead of the old `{ registry, actorActions }`
13
13
 
14
14
  | Property | Type | Description | Defined in |
15
15
  | ----------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions so handlers always read the latest state. For DOM rendering, pass `() => undefined, () => ({})` since DOM actions dispatch directly to actor without needing setState. | [json-render/types.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L185) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L178) |
16
+ | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions so handlers always read the latest state. For DOM rendering, pass `() => undefined, () => ({})` since DOM actions dispatch directly to actor without needing setState. | [json-render/types.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L185) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [json-render/types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L178) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DomRenderContext
4
4
 
5
- Defined in: [json-render/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L52)
5
+ Defined in: [json-render/types.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L52)
6
6
 
7
7
  Low-level render context passed to each `DomComponentRenderer`.
8
8
 
@@ -10,9 +10,9 @@ Low-level render context passed to each `DomComponentRenderer`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [json-render/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L66) |
14
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [json-render/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L60) |
15
- | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [json-render/types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L62) |
16
- | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [json-render/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L58) |
17
- | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [json-render/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L54) |
18
- | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [json-render/types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L56) |
13
+ | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [json-render/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L66) |
14
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [json-render/types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L60) |
15
+ | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [json-render/types.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L62) |
16
+ | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [json-render/types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L58) |
17
+ | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [json-render/types.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L54) |
18
+ | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [json-render/types.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L56) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: EventHandle
4
4
 
5
- Defined in: [json-render/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L36)
5
+ Defined in: [json-render/types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L36)
6
6
 
7
7
  Handle returned by `ComponentContext.on(eventName)`.
8
8
 
@@ -10,6 +10,6 @@ Handle returned by `ComponentContext.on(eventName)`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [json-render/types.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L44) |
14
- | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [json-render/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L38) |
15
- | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [json-render/types.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L42) |
13
+ | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [json-render/types.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L44) |
14
+ | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [json-render/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L38) |
15
+ | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [json-render/types.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L42) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayDomOptions
4
4
 
5
- Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L18)
5
+ Defined in: [xm-types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L18)
6
6
 
7
7
  Options for PlayRenderer.
8
8
 
@@ -10,5 +10,5 @@ Options for PlayRenderer.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L23) |
14
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [xm-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/xm-types.ts#L32) |
13
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Map of catalog action name → async ActionHandler function. Replaces the old `actions: Record<string, string>` string-map approach. | [xm-types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L23) |
14
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [xm-types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/xm-types.ts#L32) |
@@ -6,7 +6,7 @@
6
6
  type ActionFn<C, K> = (params) => Promise<void>;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L126)
9
+ Defined in: [json-render/types.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L126)
10
10
 
11
11
  Catalog-typed action function — mirrors `ActionFn<C, K>` from @json-render/react, /solid, /vue.
12
12
  `params` is typed to the exact param schema defined in the catalog, or `undefined` if no spec
@@ -6,7 +6,7 @@
6
6
  type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L134)
9
+ Defined in: [json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L134)
10
10
 
11
11
  Map of catalog-typed action handler functions.
12
12
  Each key is a catalog action name; each value is an `ActionFn<C, K>` for that action.
@@ -6,7 +6,7 @@
6
6
  type ComponentFn<C, K> = (ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L105)
9
+ Defined in: [json-render/types.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L105)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentRegistry<C> = { [K in keyof InferCatalogComponents<C>]: ComponentFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L111)
9
+ Defined in: [json-render/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L111)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L71)
9
+ Defined in: [json-render/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L71)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,4 +6,4 @@
6
6
  type DomRegistry = Record<string, DomComponentRenderer>;
7
7
  ```
8
8
 
9
- Defined in: [json-render/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/types.ts#L117)
9
+ Defined in: [json-render/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/types.ts#L117)
@@ -6,4 +6,4 @@
6
6
  type DomSchema = typeof schema;
7
7
  ```
8
8
 
9
- Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L60)
9
+ Defined in: [json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/schema.ts#L60)
@@ -46,7 +46,7 @@ const schema: Schema<{
46
46
  }>;
47
47
  ```
48
48
 
49
- Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-dom/src/json-render/schema.ts#L20)
49
+ Defined in: [json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-dom/src/json-render/schema.ts#L20)
50
50
 
51
51
  The schema for @xmachines/play-dom
52
52
 
@@ -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.31/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.32/packages/play-dom-router/src/connect-router.ts#L48)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
@@ -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.31/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.32/packages/play-dom-router/src/create-browser-history.ts#L120)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `BaseRouteMap` from an XState state machine.
12
12
 
@@ -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.31/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.32/packages/play-dom-router/src/create-router.ts#L52)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
@@ -2,17 +2,17 @@
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.31/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.32/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.31/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.31/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.31/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.31/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.31/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.32/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.32/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.32/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.32/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.32/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.31/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.32/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.31/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.32/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.31/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.32/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.31/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.32/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.31/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.32/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.31/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.32/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.31/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.32/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.31/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.32/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function
@@ -2,7 +2,7 @@
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.31/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.32/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.31/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.32/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.32/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.32/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.32/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.32/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.32/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.32/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.32/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.32/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.32/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.32/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.31/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.32/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.31/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.32/packages/play-dom-router/src/create-browser-history.ts#L74)
59
59
 
60
60
  #### Parameters
61
61
 
@@ -2,7 +2,7 @@
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.31/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.32/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.31/packages/play-dom-router/src/connect-router.ts#L22) |
14
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMapLike`](RouteMapLike.md) | Route map used to resolve 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.31/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.31/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.32/packages/play-dom-router/src/connect-router.ts#L22) |
14
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMapLike`](RouteMapLike.md) | Route map used to resolve 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.32/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.32/packages/play-dom-router/src/connect-router.ts#L24) |
@@ -2,7 +2,7 @@
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.31/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.32/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.31/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.31/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.31/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.31/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.31/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.32/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.32/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.32/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.32/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.32/packages/play-router/src/types.ts#L224) |
@@ -2,7 +2,7 @@
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.31/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.32/packages/play-router/src/base-route-map.ts#L100)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -55,7 +55,7 @@ map.getPathByStateId("missing"); // null
55
55
  getPathByStateId(stateId): string | null;
56
56
  ```
57
57
 
58
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L209)
58
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L209)
59
59
 
60
60
  Look up the path pattern registered for a state ID.
61
61
 
@@ -86,7 +86,7 @@ map.getPathByStateId("missing"); // null
86
86
  getStateIdByPath(path): string | null;
87
87
  ```
88
88
 
89
- Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-router/src/base-route-map.ts#L174)
89
+ Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.32/packages/play-router/src/base-route-map.ts#L174)
90
90
 
91
91
  Resolve a URL path to its mapped state ID.
92
92
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapLike
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.31/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.32/packages/play-dom-router/src/connect-router.ts#L12)
6
6
 
7
7
  Structural route-map 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.31/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.32/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.31/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.32/packages/play-dom-router/src/connect-router.ts#L13)
41
41
 
42
42
  #### Parameters
43
43
 
@@ -2,7 +2,7 @@
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.31/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.32/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: BaseRouteMapping = { stateId: "settings", path: "/setting
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.31/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.31/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.32/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.32/packages/play-router/src/base-route-map.ts#L59) |