@xmachines/docs 5.0.0 → 5.0.2

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 (524) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/README.md +2 -2
  3. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  4. package/api/@xmachines/play/errors/classes/PlayError.md +4 -4
  5. package/api/@xmachines/play/index/functions/asCleanup.md +1 -1
  6. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  7. package/api/@xmachines/play/index/functions/shallowEqualExcept.md +1 -1
  8. package/api/@xmachines/play/index/type-aliases/Cleanup.md +1 -1
  9. package/api/@xmachines/play/index/type-aliases/DisposeKey.md +1 -1
  10. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  11. package/api/@xmachines/play/index/variables/DISPOSE.md +1 -1
  12. package/api/@xmachines/play-actor/README.md +1 -1
  13. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  14. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  15. package/api/@xmachines/play-atom/README.md +2 -2
  16. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  17. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  18. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  19. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  20. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  21. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  22. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  23. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  24. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  25. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  26. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  27. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  28. package/api/@xmachines/play-atom/type-aliases/Cleanup.md +1 -1
  29. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  30. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  31. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  32. package/api/@xmachines/play-dom/README.md +1 -1
  33. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  34. package/api/@xmachines/play-dom/functions/asCleanup.md +1 -1
  35. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  36. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +3 -3
  38. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  39. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  40. package/api/@xmachines/play-dom/type-aliases/Cleanup.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  42. package/api/@xmachines/play-dom-router/README.md +8 -5
  43. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  44. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  45. package/api/@xmachines/play-dom-router/functions/asCleanup.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  48. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  49. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
  51. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  52. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  53. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  54. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  58. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +7 -7
  60. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
  61. package/api/@xmachines/play-dom-router/type-aliases/Cleanup.md +1 -1
  62. package/api/@xmachines/play-dom-router/variables/DISPOSE.md +1 -1
  63. package/api/@xmachines/play-pattern/README.md +1 -1
  64. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  65. package/api/@xmachines/play-pattern/functions/createPatternCache.md +1 -1
  66. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  67. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  68. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  69. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
  70. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  71. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  72. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  73. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  74. package/api/@xmachines/play-pattern/interfaces/PatternCache.md +3 -3
  75. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
  76. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  77. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  78. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  79. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  80. package/api/@xmachines/play-react/README.md +2 -2
  81. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  82. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  83. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  84. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  85. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  86. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  87. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  88. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  89. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  90. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  91. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  93. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  94. package/api/@xmachines/play-react-router/README.md +2 -2
  95. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  96. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  97. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  98. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  99. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  100. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  101. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  102. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  103. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  104. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  105. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  106. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  107. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  108. package/api/@xmachines/play-router/README.md +2 -2
  109. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  110. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  111. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  112. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  113. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  114. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  115. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  116. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  117. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  118. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  119. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  120. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  121. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  122. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  123. package/api/@xmachines/play-router/index/functions/createPatternCache.md +1 -1
  124. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  125. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  126. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  127. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  128. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  136. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  143. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  144. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  146. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  147. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  148. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  149. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  150. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  151. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  152. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  153. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  154. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  155. package/api/@xmachines/play-router/index/interfaces/PatternCache.md +3 -3
  156. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  157. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  158. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  159. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  160. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  161. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  162. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  163. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  164. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  165. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  166. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  167. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
  168. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  169. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  170. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  171. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
  172. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +7 -7
  173. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  174. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  175. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  176. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  177. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  178. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  179. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  180. package/api/@xmachines/play-router/index/variables/DISPOSE.md +1 -1
  181. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  182. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  183. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  184. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  185. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  186. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  187. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  188. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  189. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  190. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  191. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  192. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  193. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  194. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  195. package/api/@xmachines/play-solid/README.md +1 -1
  196. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  197. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  199. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  200. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  201. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  202. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  203. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  204. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  205. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  206. package/api/@xmachines/play-solid-router/README.md +2 -2
  207. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  208. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  209. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  210. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  211. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  212. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  213. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  214. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  215. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  216. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  217. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  218. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  219. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  220. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-svelte/README.md +2 -2
  222. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  223. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  224. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  225. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  226. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  227. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  228. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  229. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  230. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  231. package/api/@xmachines/play-svelte-spa-router/README.md +2 -2
  232. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  233. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  234. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  235. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  236. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  237. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  238. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  239. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  240. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  241. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  242. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +7 -7
  243. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  244. package/api/@xmachines/play-sveltekit-router/README.md +2 -2
  245. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  246. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  247. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  248. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  249. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +8 -8
  250. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  251. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  252. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  253. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  254. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  255. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  256. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +7 -7
  257. package/api/@xmachines/play-tanstack-react-router/README.md +2 -2
  258. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  259. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  260. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  261. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  262. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  263. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  264. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  265. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  266. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  267. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  268. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  269. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  270. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  271. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  272. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  273. package/api/@xmachines/play-tanstack-router/README.md +1 -1
  274. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  275. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  276. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  277. package/api/@xmachines/play-tanstack-solid-router/README.md +2 -2
  278. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  279. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  280. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  281. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  282. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  283. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  284. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  285. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  286. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  287. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  288. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  289. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  290. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  291. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  292. package/api/@xmachines/play-url/README.md +1 -1
  293. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  294. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  295. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  296. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  297. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  298. package/api/@xmachines/play-url/index/functions/createPatternCache.md +1 -1
  299. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  300. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  301. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  302. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  303. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  304. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  305. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  306. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  307. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  308. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  311. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  313. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  314. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
  315. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  316. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  317. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  318. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  319. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
  320. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  321. package/api/@xmachines/play-url/index/interfaces/PatternCache.md +3 -3
  322. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  323. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  324. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  325. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  326. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  327. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  328. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  329. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  330. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  331. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  332. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  333. package/api/@xmachines/play-view/README.md +1 -1
  334. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  335. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  336. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  337. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +1 -1
  338. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  339. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  340. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  341. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  342. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  343. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +1 -1
  344. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  345. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  346. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  347. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  348. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +3 -3
  349. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +2 -2
  350. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  351. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
  352. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  353. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +4 -4
  354. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +3 -3
  355. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +4 -4
  356. package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
  357. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  358. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  359. package/api/@xmachines/play-vue/README.md +2 -2
  360. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  361. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  362. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  363. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  364. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  365. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  366. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  367. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  368. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  369. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  370. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  371. package/api/@xmachines/play-vue-router/README.md +1 -1
  372. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  373. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  374. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  375. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  376. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  377. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  378. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
  379. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  380. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  381. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  382. package/api/@xmachines/play-xstate/README.md +2 -2
  383. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  384. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  385. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  386. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  387. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  388. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  389. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  390. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  391. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +11 -11
  392. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  393. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  394. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  395. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  396. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  397. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  398. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  399. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  400. package/api/@xmachines/play-xstate/index/variables/DISPOSE.md +1 -1
  401. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  402. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  403. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  404. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  405. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  406. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  407. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
  408. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  409. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  410. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  411. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  412. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  413. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  414. package/api/@xmachines/shared/README.md +1 -1
  415. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  416. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  417. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  418. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  419. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  420. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  421. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  422. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  423. package/contributing/configuration.md +2 -2
  424. package/contributing/deployment.md +23 -7
  425. package/contributing/development.md +1 -0
  426. package/contributing/migrating-to-play-atom.md +1 -1
  427. package/examples/@xmachines/play-dom-demo/README.md +44 -63
  428. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +35 -0
  429. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +27 -0
  430. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
  431. package/examples/@xmachines/play-dom-demo/functions/initShell.md +7 -6
  432. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  433. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  434. package/examples/@xmachines/play-dom-demo/variables/Button.md +12 -0
  435. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  436. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  437. package/examples/@xmachines/play-dom-demo/variables/Field.md +19 -0
  438. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  439. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  440. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  441. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  442. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  443. package/examples/@xmachines/play-dom-demo/variables/Panel.md +14 -0
  444. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  445. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  446. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  447. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +190 -165
  448. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +30 -0
  449. package/examples/@xmachines/play-dom-router-demo/README.md +26 -34
  450. package/examples/@xmachines/play-react-demo/README.md +33 -57
  451. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +35 -0
  452. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  453. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  454. package/examples/@xmachines/play-react-demo/variables/Button.md +12 -0
  455. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  456. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  457. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +4 -3
  458. package/examples/@xmachines/play-react-demo/variables/Field.md +18 -0
  459. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  460. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  461. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  462. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  463. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  464. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  465. package/examples/@xmachines/play-react-demo/variables/Panel.md +15 -0
  466. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  467. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  468. package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -1
  469. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  470. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +190 -165
  471. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +30 -0
  472. package/examples/@xmachines/play-react-router-demo/README.md +32 -32
  473. package/examples/@xmachines/play-solid-demo/README.md +33 -57
  474. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +35 -0
  475. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  476. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  477. package/examples/@xmachines/play-solid-demo/variables/Button.md +11 -0
  478. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  479. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  480. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +5 -3
  481. package/examples/@xmachines/play-solid-demo/variables/Field.md +11 -0
  482. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  483. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  484. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  485. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  486. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  487. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  488. package/examples/@xmachines/play-solid-demo/variables/Panel.md +11 -0
  489. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  490. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  491. package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -1
  492. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  493. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +114 -2
  494. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +30 -0
  495. package/examples/@xmachines/play-solid-router-demo/README.md +20 -23
  496. package/examples/@xmachines/play-svelte-demo/README.md +38 -44
  497. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +35 -0
  498. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  499. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +114 -2
  500. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +30 -0
  501. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +21 -27
  502. package/examples/@xmachines/play-sveltekit-router-demo/README.md +21 -27
  503. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +29 -31
  504. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +25 -27
  505. package/examples/@xmachines/play-vue-demo/README.md +36 -60
  506. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +35 -0
  507. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  508. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  509. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +114 -2
  510. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +11 -0
  511. package/examples/@xmachines/play-vue-router-demo/README.md +12 -23
  512. package/examples/form-validation.md +6 -3
  513. package/examples/multi-router-integration.md +6 -3
  514. package/examples/routing-patterns.md +6 -3
  515. package/guides/getting-started.md +8 -4
  516. package/package.json +2 -1
  517. package/examples/@xmachines/play-react-demo/functions/App.md +0 -13
  518. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +0 -20
  519. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +0 -20
  520. package/examples/@xmachines/play-react-demo/functions/Shell.md +0 -22
  521. package/examples/@xmachines/play-solid-demo/functions/App.md +0 -13
  522. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +0 -20
  523. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +0 -20
  524. package/examples/@xmachines/play-solid-demo/functions/Shell.md +0 -22
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L39)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L39)
10
10
 
11
11
  The type-only interface of the TanStack Router surface that
12
12
  `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
24
24
 
25
25
  #### location
26
26
 
@@ -69,7 +69,7 @@ subscribe(handler): () => void;
69
69
  optional options?: object;
70
70
  ```
71
71
 
72
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L58)
72
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L58)
73
73
 
74
74
  The options of the router. The bridge reads `parseSearch` only.
75
75
 
@@ -103,7 +103,7 @@ optional parseSearch(search): Record<string, unknown>;
103
103
  optional load(): void | Promise<void>;
104
104
  ```
105
105
 
106
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L71)
106
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L71)
107
107
 
108
108
  Runs the TanStack route matching and the loaders again for the current location.
109
109
  This method is optional. The bridge calls it after every navigation. The matching
@@ -128,7 +128,7 @@ bridge then synchronizes synchronously.
128
128
  navigate(args): void;
129
129
  ```
130
130
 
131
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L48)
131
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L48)
132
132
 
133
133
  Navigates to a location. `search` carries the query of the target.
134
134
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  **TanStack Solid Router adapter for XMachines Universal Player Architecture**
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-solid-router)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-tanstack-solid-router)
8
8
 
9
9
  This package integrates TanStack Solid Router with the atoms. The logic then drives the navigation through the Solid.js reactivity.
10
10
 
@@ -294,7 +294,7 @@ The routing infrastructure therefore stays passive, and the state machine keeps
294
294
 
295
295
  ## License
296
296
 
297
- MIT — see [LICENSE](LICENSE).
297
+ MIT — see [LICENSE](../../../LICENSE).
298
298
 
299
299
  ## Classes
300
300
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L177)
5
+ Defined in: [play-router/src/base-route-map.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L177)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -65,7 +65,7 @@ map.getPathByStateId("missing"); // null
65
65
  new RouteMap(mappings, options?): RouteMap;
66
66
  ```
67
67
 
68
- Defined in: [play-router/src/base-route-map.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L210)
68
+ Defined in: [play-router/src/base-route-map.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L210)
69
69
 
70
70
  Builds a route map from an array of the mappings between a state ID and a path.
71
71
 
@@ -93,7 +93,7 @@ candidates is therefore efficient.
93
93
  getPathByStateId(stateId): string | null;
94
94
  ```
95
95
 
96
- Defined in: [play-router/src/base-route-map.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L324)
96
+ Defined in: [play-router/src/base-route-map.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L324)
97
97
 
98
98
  Returns the path pattern of a state ID.
99
99
 
@@ -129,7 +129,7 @@ map.getPathByStateId("missing"); // null
129
129
  getStateIdByPath(path): string | null;
130
130
  ```
131
131
 
132
- Defined in: [play-router/src/base-route-map.ts:279](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L279)
132
+ Defined in: [play-router/src/base-route-map.ts:279](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L279)
133
133
 
134
134
  Resolves a URL path to its state ID.
135
135
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackSolidRouterBridge
4
4
 
5
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L133)
5
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L133)
6
6
 
7
7
  The shared TanStack Router adapter. It implements the RouterBridge protocol through RouterBridgeBase
8
8
 
@@ -56,7 +56,7 @@ new TanStackSolidRouterBridge(
56
56
  ): TanStackRouterBridgeBase;
57
57
  ```
58
58
 
59
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L151)
59
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L151)
60
60
 
61
61
  Creates a TanStack Router bridge
62
62
 
@@ -87,7 +87,7 @@ Creates a TanStack Router bridge
87
87
  get basePath(): string;
88
88
  ```
89
89
 
90
- Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L282)
90
+ Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L282)
91
91
 
92
92
  The resolved URL prefix that the machine of this bridge is mounted under, or `""`
93
93
  when the machine owns the complete router.
@@ -112,7 +112,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
112
112
  get basePathParams(): Readonly<Record<string, string>>;
113
113
  ```
114
114
 
115
- Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L311)
115
+ Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L311)
116
116
 
117
117
  The resolved values of the `:param` segments of the mount, or `{}` for a prefix
118
118
  without a param.
@@ -163,7 +163,7 @@ mount while the machine stays on the same route, and no event goes out.
163
163
  connect(): void;
164
164
  ```
165
165
 
166
- Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L533)
166
+ Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L533)
167
167
 
168
168
  Connects the router bridge to the Actor.
169
169
 
@@ -197,7 +197,7 @@ An adapter that needs a different behavior of the first synchronization override
197
197
  disconnect(): void;
198
198
  ```
199
199
 
200
- Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L791)
200
+ Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L791)
201
201
 
202
202
  Disconnects the router bridge from the Actor.
203
203
 
@@ -220,7 +220,7 @@ framework.
220
220
  setBasePath(basePath?, basePathParams?): void;
221
221
  ```
222
222
 
223
- Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/router-bridge-base.ts#L351)
223
+ Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/router-bridge-base.ts#L351)
224
224
 
225
225
  Moves the machine to a different mount point, while it stays connected.
226
226
 
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter, TActorBase>(BridgeCtor): <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51)
9
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51)
10
10
 
11
11
  Builds a `PlayRouterProvider` for one Solid bridge class.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L336)
5
+ Defined in: [play-router/src/types.ts:336](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L336)
6
6
 
7
7
  The routing event, with its parameters and its query
8
8
 
@@ -122,9 +122,9 @@ analysis of the pattern.
122
122
 
123
123
  | Property | Modifier | Type | Description | Defined in |
124
124
  | -------------------------------------- | ---------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-data"></a> `data?` | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L346) |
126
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | - | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L347) |
127
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | - | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L339) |
128
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | - | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L340) |
129
- | <a id="property-to"></a> `to` | `readonly` | `string` | - | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L338) |
130
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | - | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L337) |
125
+ | <a id="property-data"></a> `data?` | `readonly` | [`RouteData`](../../play-router/index/type-aliases/RouteData.md) | The extra data that the SENDER of this event supplies: a router bridge, or the code of an application. It is not what the target state declares — that is [RouteObject.data](../../play-router/index/interfaces/RouteObject.md#property-data), and a resolver there reads this field. | [play-router/src/types.ts:346](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L346) |
126
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | - | [play-router/src/types.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L347) |
127
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | - | [play-router/src/types.ts:339](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L339) |
128
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | - | [play-router/src/types.ts:340](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L340) |
129
+ | <a id="property-to"></a> `to` | `readonly` | `string` | - | [play-router/src/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L338) |
130
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | - | [play-router/src/types.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L337) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L28)
5
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L28)
6
6
 
7
7
  The props of the `PlayRouterProvider` of TanStack Solid Router.
8
8
 
@@ -22,11 +22,11 @@ The props of the `PlayRouterProvider` of TanStack Solid Router.
22
22
 
23
23
  | Property | Modifier | Type | Description | Inherited from | Defined in |
24
24
  | ------------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-actor"></a> `actor` | `public` | `TActor` | The actor to keep in step with the router. It must be a stable reference: give the same actor instance on every render. An actor in the JSX, or a new actor on each render, makes the bridge disconnect and connect again each time. | `PlayRouterProviderBaseProps.actor` | [play-router/src/provider-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L47) |
26
- | <a id="property-basepath"></a> `basePath?` | `public` | `string` | Mounts the routes of the machine under a URL prefix that the host owns, so that the routes of the host and the routes of the machine share one router. `actor`, `router`, and `routeMap` each need a stable reference. This prop needs none, and it rebuilds the bridge never: a change moves the live bridge with `setBasePath()`, so a host route that renders again with a new prefix keeps the actor, the route map, and its cache. The prefix says WHERE an actor is mounted, and never WHICH actor is mounted. An actor never changes identity, so a prefix segment that IDENTIFIES the actor gives a different `actor` prop instead, and THAT rebuilds the bridge — which is correct, because one actor takes one bridge. A location outside the prefix belongs completely to the host: the bridge sends no event there, and it corrects no URL there. Every `:param` needs a value. An unresolved one throws a `MissingBasePathParamError` out of the mount effect, because the bridge writes no URL without it. Render this component only after the host holds the value, which a route loader or a `useParams()` call does already. | `PlayRouterProviderBaseProps.basePath` | [play-router/src/provider-lifecycle.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L85) |
27
- | <a id="property-basepathparams"></a> `basePathParams?` | `public` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [PlayRouterProviderBaseProps.basePath](../../play-react-router/interfaces/PlayRouterProviderProps.md#property-basepath), for example `{ machineId }` for `basePath="/:machineId/play"`. An inline object literal is correct here: the provider compares this prop by value, and a move to the same prefix does nothing. | `PlayRouterProviderBaseProps.basePathParams` | [play-router/src/provider-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L94) |
28
- | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | `PlayRouterProviderBaseProps.compiledCache` | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/url-pattern-utils.ts#L119) |
29
- | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | `PlayRouterProviderBaseProps.patternCache` | [play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-pattern/src/cache.ts#L40) |
30
- | <a id="property-renderer"></a> `renderer` | `public` | (`actor`, `router`) => `any` | The renderer callback receives the same concrete actor type as the prop. | `PlayRouterProviderBaseProps.renderer` | [play-router/src/provider-lifecycle.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L96) |
31
- | <a id="property-routemap"></a> `routeMap` | `public` | [`RouteMap`](../classes/RouteMap.md) | The route map of both directions, for the lookup between a state ID and a URL path. **It must be a stable reference.** The provider builds the bridge again on each change of the identity of `routeMap`. A value in the JSX, for example `createRouteMapFromTree(routeTree)`, makes a new object on every render, and the bridge therefore connects again on every render. Hold the value with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | `PlayRouterProviderBaseProps.routeMap` | [play-router/src/provider-lifecycle.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L62) |
32
- | <a id="property-router"></a> `router` | `public` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router instance that the bridge keeps in step with the actor. It must be a stable reference. | `PlayRouterProviderBaseProps.router` | [play-router/src/provider-lifecycle.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L49) |
25
+ | <a id="property-actor"></a> `actor` | `public` | `TActor` | The actor to keep in step with the router. It must be a stable reference: give the same actor instance on every render. An actor in the JSX, or a new actor on each render, makes the bridge disconnect and connect again each time. | `PlayRouterProviderBaseProps.actor` | [play-router/src/provider-lifecycle.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L47) |
26
+ | <a id="property-basepath"></a> `basePath?` | `public` | `string` | Mounts the routes of the machine under a URL prefix that the host owns, so that the routes of the host and the routes of the machine share one router. `actor`, `router`, and `routeMap` each need a stable reference. This prop needs none, and it rebuilds the bridge never: a change moves the live bridge with `setBasePath()`, so a host route that renders again with a new prefix keeps the actor, the route map, and its cache. The prefix says WHERE an actor is mounted, and never WHICH actor is mounted. An actor never changes identity, so a prefix segment that IDENTIFIES the actor gives a different `actor` prop instead, and THAT rebuilds the bridge — which is correct, because one actor takes one bridge. A location outside the prefix belongs completely to the host: the bridge sends no event there, and it corrects no URL there. Every `:param` needs a value. An unresolved one throws a `MissingBasePathParamError` out of the mount effect, because the bridge writes no URL without it. Render this component only after the host holds the value, which a route loader or a `useParams()` call does already. | `PlayRouterProviderBaseProps.basePath` | [play-router/src/provider-lifecycle.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L85) |
27
+ | <a id="property-basepathparams"></a> `basePathParams?` | `public` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [PlayRouterProviderBaseProps.basePath](../../play-react-router/interfaces/PlayRouterProviderProps.md#property-basepath), for example `{ machineId }` for `basePath="/:machineId/play"`. An inline object literal is correct here: the provider compares this prop by value, and a move to the same prefix does nothing. | `PlayRouterProviderBaseProps.basePathParams` | [play-router/src/provider-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L94) |
28
+ | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | `PlayRouterProviderBaseProps.compiledCache` | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L119) |
29
+ | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | `PlayRouterProviderBaseProps.patternCache` | [play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L40) |
30
+ | <a id="property-renderer"></a> `renderer` | `public` | (`actor`, `router`) => `any` | The renderer callback receives the same concrete actor type as the prop. | `PlayRouterProviderBaseProps.renderer` | [play-router/src/provider-lifecycle.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L96) |
31
+ | <a id="property-routemap"></a> `routeMap` | `public` | [`RouteMap`](../classes/RouteMap.md) | The route map of both directions, for the lookup between a state ID and a URL path. **It must be a stable reference.** The provider builds the bridge again on each change of the identity of `routeMap`. A value in the JSX, for example `createRouteMapFromTree(routeTree)`, makes a new object on every render, and the bridge therefore connects again on every render. Hold the value with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | `PlayRouterProviderBaseProps.routeMap` | [play-router/src/provider-lifecycle.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L62) |
32
+ | <a id="property-router"></a> `router` | `public` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router instance that the bridge keeps in step with the actor. It must be a stable reference. | `PlayRouterProviderBaseProps.router` | [play-router/src/provider-lifecycle.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RoutableActor
4
4
 
5
- Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L392)
5
+ Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L392)
6
6
 
7
7
  The minimal actor interface that `RouterBridgeBase` and every framework router
8
8
  adapter require.
@@ -46,8 +46,8 @@ class MyBridge extends RouterBridgeBase {
46
46
 
47
47
  | Property | Modifier | Type | Inherited from | Defined in |
48
48
  | ------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
49
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../play-router/index/interfaces/Routable.md#property-currentroute) | [play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L354) |
50
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [`Routable`](../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../play-router/index/interfaces/Routable.md#property-initialroute) | [play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L355) |
49
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`ReadonlyAtom`](../../play-atom/interfaces/ReadonlyAtom.md)\<`string` \| `null`\> | [`Routable`](../../play-router/index/interfaces/Routable.md).[`currentRoute`](../../play-router/index/interfaces/Routable.md#property-currentroute) | [play-router/src/types.ts:354](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L354) |
50
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | [`Routable`](../../play-router/index/interfaces/Routable.md).[`initialRoute`](../../play-router/index/interfaces/Routable.md#property-initialroute) | [play-router/src/types.ts:355](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L355) |
51
51
 
52
52
  ## Methods
53
53
 
@@ -57,7 +57,7 @@ class MyBridge extends RouterBridgeBase {
57
57
  send(event): void;
58
58
  ```
59
59
 
60
- Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L394)
60
+ Defined in: [play-router/src/types.ts:394](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L394)
61
61
 
62
62
  Sends a route navigation event to the actor.
63
63
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L565)
5
+ Defined in: [play-router/src/types.ts:565](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L565)
6
6
 
7
7
  The options of `createRouteMap` and of `createRouteMapFromTree`.
8
8
 
@@ -14,6 +14,6 @@ The options of `createRouteMap` and of `createRouteMapFromTree`.
14
14
 
15
15
  | Property | Modifier | Type | Description | Inherited from | Defined in |
16
16
  | ---------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/url-pattern-utils.ts#L119) |
18
- | <a id="property-pathcache"></a> `pathCache?` | `public` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<`string` \| `null`\> | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone, of 500 entries in each of two generations. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createPatternCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | - | [play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L584) |
19
- | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../play-router/index/interfaces/CompileOptions.md#property-patterncache) | [play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-pattern/src/cache.ts#L40) |
17
+ | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`compiledCache`](../../play-router/index/interfaces/CompileOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/url-pattern-utils.ts#L119) |
18
+ | <a id="property-pathcache"></a> `pathCache?` | `public` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<`string` \| `null`\> | The cache of the state that a VISITED PATH resolves to, or `null` for a path that resolves to none. The default is a cache of this map alone, of 500 entries in each of two generations. Pass one to raise that bound, to share the resolution across maps, or to give it an eviction policy of your own: `createPatternCache(5000)` builds one, and so does any object with a `get` and a `set`. A cache that a caller passes is keyed by the ROUTE TABLE. Two maps built from the same mappings, in the same order, therefore read each other's answers — which is what a server that rebuilds its map for each request wants — and two maps built from different mappings never do, because a map with no route for a path writes `null` for it and a map that holds one must not read that. The keys are the paths that a visitor reaches, so the key space is unbounded: a cache with no bound of its own grows for the life of the process. | - | [play-router/src/types.ts:584](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L584) |
19
+ | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](../../play-router/index/interfaces/PatternCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [`CompileOptions`](../../play-router/index/interfaces/CompileOptions.md).[`patternCache`](../../play-router/index/interfaces/CompileOptions.md#property-patterncache) | [play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-pattern/src/cache.ts#L40) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L58)
5
+ Defined in: [play-router/src/base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L58)
6
6
 
7
7
  One entry of the map between a state ID and a path.
8
8
 
@@ -24,5 +24,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
24
24
 
25
25
  | Property | Modifier | Type | Description | Defined in |
26
26
  | --------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
27
- | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L62) |
28
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/base-route-map.ts#L60) |
27
+ | <a id="property-path"></a> `path` | `readonly` | `string` | The pattern of the URL path, for example `"/"`, `"/profile/:userId"`, or `"/settings/:section?"` | [play-router/src/base-route-map.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L62) |
28
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the state machine, for example `"home"` or `"#profile"` | [play-router/src/base-route-map.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/base-route-map.ts#L60) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L436)
5
+ Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L436)
6
6
 
7
7
  The RouterBridge interface of a runtime infrastructure adapter
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L453)
57
+ Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L453)
58
58
 
59
59
  Connects the router bridge to the Actor
60
60
 
@@ -84,7 +84,7 @@ await bridge.connect();
84
84
  disconnect(): void | Promise<void>;
85
85
  ```
86
86
 
87
- Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/types.ts#L469)
87
+ Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/types.ts#L469)
88
88
 
89
89
  Disconnects the router bridge from the Actor
90
90
 
@@ -11,7 +11,7 @@ type PlayRouterBridgeConstructor<TRouter, TActor> = (
11
11
  ) => RouterBridge;
12
12
  ```
13
13
 
14
- Defined in: [play-router/src/provider-lifecycle.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-router/src/provider-lifecycle.ts#L119)
14
+ Defined in: [play-router/src/provider-lifecycle.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-router/src/provider-lifecycle.ts#L119)
15
15
 
16
16
  The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
17
17
 
@@ -10,7 +10,7 @@ type PlayRouterProviderBaseProps<TRouter, TActor> = PlayRouterProviderBaseProps<
10
10
  >;
11
11
  ```
12
12
 
13
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L34)
13
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L34)
14
14
 
15
15
  The props of a Solid `PlayRouterProvider`.
16
16
 
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof TanStackSolidRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L21)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L21)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L39)
9
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L39)
10
10
 
11
11
  The type-only interface of the TanStack Router surface that
12
12
  `TanStackRouterBridgeBase` uses. An instance of `@tanstack/react-router` and an
@@ -20,7 +20,7 @@ instance of `@tanstack/solid-router` both satisfy it.
20
20
  history: object;
21
21
  ```
22
22
 
23
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
23
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L72)
24
24
 
25
25
  #### location
26
26
 
@@ -69,7 +69,7 @@ subscribe(handler): () => void;
69
69
  optional options?: object;
70
70
  ```
71
71
 
72
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L58)
72
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L58)
73
73
 
74
74
  The options of the router. The bridge reads `parseSearch` only.
75
75
 
@@ -103,7 +103,7 @@ optional parseSearch(search): Record<string, unknown>;
103
103
  optional load(): void | Promise<void>;
104
104
  ```
105
105
 
106
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L71)
106
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L71)
107
107
 
108
108
  Runs the TanStack route matching and the loaders again for the current location.
109
109
  This method is optional. The bridge calls it after every navigation. The matching
@@ -128,7 +128,7 @@ bridge then synchronizes synchronously.
128
128
  navigate(args): void;
129
129
  ```
130
130
 
131
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L48)
131
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L48)
132
132
 
133
133
  Navigates to a location. `search` carries the query of the target.
134
134
 
@@ -6,7 +6,7 @@
6
6
  const PlayRouterProvider: <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L41)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L41)
10
10
 
11
11
  Connects a `PlayerActor` to TanStack Solid Router. It keeps the actor state and the
12
12
  browser URL in step, in both directions.
@@ -4,7 +4,7 @@
4
4
 
5
5
  The URL layer of the XMachines Play Architecture.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-url)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.2-blue)](https://www.npmjs.com/package/@xmachines/play-url)
8
8
 
9
9
  ## Installation
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidBasePathError
4
4
 
5
- Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L99)
5
+ Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/errors.ts#L99)
6
6
 
7
7
  Thrown when a `basePath` option resolves to one concrete URL prefix never.
8
8
 
@@ -45,7 +45,7 @@ try {
45
45
  new InvalidBasePathError(basePath, reason): InvalidBasePathError;
46
46
  ```
47
47
 
48
- Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L103)
48
+ Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/errors.ts#L103)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -66,12 +66,12 @@ Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/
66
66
 
67
67
  | Property | Modifier | Type | Description | Inherited from | Defined in |
68
68
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
69
- | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option of the refusal, exactly as the caller gave it. | - | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play-url/src/errors.ts#L101) |
69
+ | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option of the refusal, exactly as the caller gave it. | - | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-url/src/errors.ts#L101) |
70
70
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
71
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L76) |
71
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L76) |
72
72
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
73
73
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
74
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.0/packages/play/src/errors.ts#L66) |
74
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"RouterBridgeBase"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play/src/errors.ts#L66) |
75
75
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
76
76
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | - |
77
77