@xmachines/docs 7.3.0 → 7.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (582) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  3. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  4. package/api/@xmachines/core/errors/classes/BaseError.md +4 -4
  5. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
  6. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  7. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  8. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  9. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  10. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  12. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  13. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  14. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  15. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  16. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  18. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  19. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  20. package/api/@xmachines/play/errors/classes/PlayError.md +4 -4
  21. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  22. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  23. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  24. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  25. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  26. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  27. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  28. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  29. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  30. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  31. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  32. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  33. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  34. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  35. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  36. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  37. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  38. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  39. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  40. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  41. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  42. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  43. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +3 -3
  44. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  45. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
  46. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  47. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  48. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  49. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  51. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  52. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  54. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  55. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  56. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  57. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  58. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  60. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  61. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  62. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
  63. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  64. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  65. package/api/@xmachines/play-pattern/functions/createLruCache.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/KeyValueCache.md +3 -3
  71. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  72. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  73. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  74. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  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/classes/PlayErrorBoundary.md +6 -6
  81. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  82. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  83. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  85. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  86. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  87. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  88. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  89. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  90. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  92. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  96. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  97. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  98. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  99. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  100. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  101. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  102. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  103. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  104. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  105. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  106. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  107. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  108. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  109. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  110. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  111. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  112. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  113. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  114. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  115. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  116. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  117. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  118. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  119. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  120. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  121. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  122. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  123. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  124. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  125. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  126. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  127. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  128. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  133. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  143. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  144. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  145. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  146. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  147. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  148. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  149. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  150. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  151. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  152. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  153. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  154. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  155. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  156. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  158. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  159. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  160. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  161. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  162. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  163. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  164. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
  165. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  166. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  167. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  168. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
  169. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
  170. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  171. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  172. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  173. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  174. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  175. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  176. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  177. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  178. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  179. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  180. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  181. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  182. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  183. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  184. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  185. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  186. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  187. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  188. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  189. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  190. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  191. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  192. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  194. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  195. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  196. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  197. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  198. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  199. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  200. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  201. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  202. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  203. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  204. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  205. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  206. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  207. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  208. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  209. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  210. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  211. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  212. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  213. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  214. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  215. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  216. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  217. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  218. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  219. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  220. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  221. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  222. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  223. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  224. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  225. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  226. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  227. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  228. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  229. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  230. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  231. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  232. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  233. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  234. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
  235. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  236. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  237. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  238. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  239. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  240. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +9 -9
  241. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  242. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  243. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  244. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  245. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  246. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  247. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
  248. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +6 -6
  249. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +1 -1
  250. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  251. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  252. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  253. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  254. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  255. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  256. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  257. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  258. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  259. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  260. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  261. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  262. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  263. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  264. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  265. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  266. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  267. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  268. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  269. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  270. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  271. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  272. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  273. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  274. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  275. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  276. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  277. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  278. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  279. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  280. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  281. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  282. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  283. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  284. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  285. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  286. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  287. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  288. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  289. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  290. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  291. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  292. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  293. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  294. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  295. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  296. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  297. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  298. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  299. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  300. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  301. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  302. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  303. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +3 -3
  304. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  305. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  306. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  307. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  308. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  309. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +2 -2
  310. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  311. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  312. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  313. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  314. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  315. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  316. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  317. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  318. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  319. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  320. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  321. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  322. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +6 -6
  323. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  324. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +6 -6
  325. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  326. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +1 -1
  327. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  328. package/api/@xmachines/play-view/index/functions/composeViews.md +1 -1
  329. package/api/@xmachines/play-view/index/functions/createActorProxy.md +1 -1
  330. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +1 -1
  331. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  332. package/api/@xmachines/play-view/index/functions/createViewSession.md +1 -1
  333. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  334. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +1 -1
  335. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  336. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  337. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  338. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  339. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  340. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  341. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  342. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +5 -5
  343. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +2 -2
  344. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +3 -3
  345. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  346. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
  347. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  348. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +2 -2
  349. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +3 -3
  350. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +7 -7
  351. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +3 -3
  352. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +6 -6
  353. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +4 -4
  354. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +5 -5
  355. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +4 -4
  356. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +3 -3
  357. package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
  358. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +1 -1
  359. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  360. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  361. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  362. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  363. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  364. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
  365. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
  366. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  367. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  368. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  369. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  370. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  371. package/api/@xmachines/play-vue/variables/PlayRenderer.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/errors/classes/ActorThrewNonErrorError.md +4 -4
  383. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  384. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  385. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  386. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  387. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  388. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  389. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  390. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
  391. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  392. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  393. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  394. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  395. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  396. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  397. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  398. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  399. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  400. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  401. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  402. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  403. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  404. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  405. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
  406. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  407. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  408. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  409. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  410. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  411. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  412. package/api/@xmachines/runtime-wasi/variables/component.md +1 -1
  413. package/api/@xmachines/runtime-wasi/variables/schemas.md +1 -1
  414. package/api/@xmachines/runtime-wasi/variables/wit.md +1 -1
  415. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  416. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  417. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  418. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  419. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  420. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  421. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  422. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
  423. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  424. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  425. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  426. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  427. package/api/trains.json +52 -0
  428. package/contributing/configuration.md +3 -1
  429. package/contributing/deployment.md +6 -8
  430. package/examples/@xmachines/play-dom-gallery-demo/functions/createConfirmDialog.md +1 -1
  431. package/examples/@xmachines/play-dom-gallery-demo/functions/createDebugPanel.md +1 -1
  432. package/examples/@xmachines/play-dom-gallery-demo/functions/initApp.md +1 -1
  433. package/examples/@xmachines/play-dom-gallery-demo/functions/initShell.md +1 -1
  434. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  435. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  436. package/examples/@xmachines/play-dom-gallery-demo/interfaces/ShellOptions.md +7 -7
  437. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  438. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  439. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  440. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  441. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GalleryActor.md +1 -1
  442. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GallerySlug.md +1 -1
  443. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/KitCatalog.md +1 -1
  444. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  445. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  446. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  447. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  448. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  449. package/examples/@xmachines/play-dom-gallery-demo/variables/Button.md +1 -1
  450. package/examples/@xmachines/play-dom-gallery-demo/variables/Field.md +1 -1
  451. package/examples/@xmachines/play-dom-gallery-demo/variables/Page.md +1 -1
  452. package/examples/@xmachines/play-dom-gallery-demo/variables/Panel.md +1 -1
  453. package/examples/@xmachines/play-dom-gallery-demo/variables/Text.md +1 -1
  454. package/examples/@xmachines/play-dom-gallery-demo/variables/authCatalog.md +1 -1
  455. package/examples/@xmachines/play-dom-gallery-demo/variables/demoComponents.md +6 -6
  456. package/examples/@xmachines/play-dom-gallery-demo/variables/donutCatalog.md +1 -1
  457. package/examples/@xmachines/play-dom-gallery-demo/variables/fetchCatalog.md +1 -1
  458. package/examples/@xmachines/play-dom-gallery-demo/variables/flightCatalog.md +1 -1
  459. package/examples/@xmachines/play-dom-gallery-demo/variables/galleryMachines.md +1 -1
  460. package/examples/@xmachines/play-dom-gallery-demo/variables/stopwatchCatalog.md +1 -1
  461. package/examples/@xmachines/play-dom-gallery-demo/variables/temperatureCatalog.md +1 -1
  462. package/examples/@xmachines/play-dom-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  463. package/examples/@xmachines/play-dom-gallery-demo/variables/todoMvcCatalog.md +1 -1
  464. package/examples/@xmachines/play-dom-gallery-demo/variables/triviaCatalog.md +1 -1
  465. package/examples/@xmachines/play-react-gallery-demo/functions/App.md +1 -1
  466. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  467. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  468. package/examples/@xmachines/play-react-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  469. package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  470. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  471. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  472. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md +1 -1
  473. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md +1 -1
  474. package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md +1 -1
  475. package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  476. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  477. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  478. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  479. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  480. package/examples/@xmachines/play-react-gallery-demo/variables/Button.md +1 -1
  481. package/examples/@xmachines/play-react-gallery-demo/variables/DebugPanel.md +1 -1
  482. package/examples/@xmachines/play-react-gallery-demo/variables/Field.md +1 -1
  483. package/examples/@xmachines/play-react-gallery-demo/variables/Page.md +1 -1
  484. package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md +1 -1
  485. package/examples/@xmachines/play-react-gallery-demo/variables/Shell.md +1 -1
  486. package/examples/@xmachines/play-react-gallery-demo/variables/Text.md +1 -1
  487. package/examples/@xmachines/play-react-gallery-demo/variables/authCatalog.md +1 -1
  488. package/examples/@xmachines/play-react-gallery-demo/variables/demoComponents.md +6 -6
  489. package/examples/@xmachines/play-react-gallery-demo/variables/donutCatalog.md +1 -1
  490. package/examples/@xmachines/play-react-gallery-demo/variables/fetchCatalog.md +1 -1
  491. package/examples/@xmachines/play-react-gallery-demo/variables/flightCatalog.md +1 -1
  492. package/examples/@xmachines/play-react-gallery-demo/variables/galleryMachines.md +1 -1
  493. package/examples/@xmachines/play-react-gallery-demo/variables/stopwatchCatalog.md +1 -1
  494. package/examples/@xmachines/play-react-gallery-demo/variables/temperatureCatalog.md +1 -1
  495. package/examples/@xmachines/play-react-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  496. package/examples/@xmachines/play-react-gallery-demo/variables/todoMvcCatalog.md +1 -1
  497. package/examples/@xmachines/play-react-gallery-demo/variables/triviaCatalog.md +1 -1
  498. package/examples/@xmachines/play-solid-gallery-demo/functions/App.md +1 -1
  499. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  500. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  501. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  502. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  503. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  504. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  505. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GalleryActor.md +1 -1
  506. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GallerySlug.md +1 -1
  507. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/KitCatalog.md +1 -1
  508. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  509. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  510. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  511. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  512. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  513. package/examples/@xmachines/play-solid-gallery-demo/variables/Button.md +1 -1
  514. package/examples/@xmachines/play-solid-gallery-demo/variables/DebugPanel.md +1 -1
  515. package/examples/@xmachines/play-solid-gallery-demo/variables/Field.md +1 -1
  516. package/examples/@xmachines/play-solid-gallery-demo/variables/Page.md +1 -1
  517. package/examples/@xmachines/play-solid-gallery-demo/variables/Panel.md +1 -1
  518. package/examples/@xmachines/play-solid-gallery-demo/variables/Shell.md +1 -1
  519. package/examples/@xmachines/play-solid-gallery-demo/variables/Text.md +1 -1
  520. package/examples/@xmachines/play-solid-gallery-demo/variables/authCatalog.md +1 -1
  521. package/examples/@xmachines/play-solid-gallery-demo/variables/demoComponents.md +6 -6
  522. package/examples/@xmachines/play-solid-gallery-demo/variables/donutCatalog.md +1 -1
  523. package/examples/@xmachines/play-solid-gallery-demo/variables/fetchCatalog.md +1 -1
  524. package/examples/@xmachines/play-solid-gallery-demo/variables/flightCatalog.md +1 -1
  525. package/examples/@xmachines/play-solid-gallery-demo/variables/galleryMachines.md +1 -1
  526. package/examples/@xmachines/play-solid-gallery-demo/variables/stopwatchCatalog.md +1 -1
  527. package/examples/@xmachines/play-solid-gallery-demo/variables/temperatureCatalog.md +1 -1
  528. package/examples/@xmachines/play-solid-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  529. package/examples/@xmachines/play-solid-gallery-demo/variables/todoMvcCatalog.md +1 -1
  530. package/examples/@xmachines/play-solid-gallery-demo/variables/triviaCatalog.md +1 -1
  531. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  532. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  533. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  534. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  535. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  536. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  537. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GalleryActor.md +1 -1
  538. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GallerySlug.md +1 -1
  539. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/KitCatalog.md +1 -1
  540. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  541. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  542. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  543. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  544. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  545. package/examples/@xmachines/play-svelte-gallery-demo/variables/authCatalog.md +1 -1
  546. package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md +6 -6
  547. package/examples/@xmachines/play-svelte-gallery-demo/variables/donutCatalog.md +1 -1
  548. package/examples/@xmachines/play-svelte-gallery-demo/variables/fetchCatalog.md +1 -1
  549. package/examples/@xmachines/play-svelte-gallery-demo/variables/flightCatalog.md +1 -1
  550. package/examples/@xmachines/play-svelte-gallery-demo/variables/galleryMachines.md +1 -1
  551. package/examples/@xmachines/play-svelte-gallery-demo/variables/stopwatchCatalog.md +1 -1
  552. package/examples/@xmachines/play-svelte-gallery-demo/variables/temperatureCatalog.md +1 -1
  553. package/examples/@xmachines/play-svelte-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  554. package/examples/@xmachines/play-svelte-gallery-demo/variables/todoMvcCatalog.md +1 -1
  555. package/examples/@xmachines/play-svelte-gallery-demo/variables/triviaCatalog.md +1 -1
  556. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryMachineEntry.md +4 -4
  557. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryRuntime.md +3 -3
  558. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/AuthCatalog.md +1 -1
  559. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/DonutCatalog.md +1 -1
  560. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FetchCatalog.md +1 -1
  561. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FlightCatalog.md +1 -1
  562. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GalleryActor.md +1 -1
  563. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GallerySlug.md +1 -1
  564. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/KitCatalog.md +1 -1
  565. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/StopwatchCatalog.md +1 -1
  566. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TemperatureCatalog.md +1 -1
  567. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TicTacToeCatalog.md +1 -1
  568. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TodoMvcCatalog.md +1 -1
  569. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TriviaCatalog.md +1 -1
  570. package/examples/@xmachines/play-vue-gallery-demo/variables/App.md +1 -1
  571. package/examples/@xmachines/play-vue-gallery-demo/variables/authCatalog.md +1 -1
  572. package/examples/@xmachines/play-vue-gallery-demo/variables/demoComponents.md +1 -1
  573. package/examples/@xmachines/play-vue-gallery-demo/variables/donutCatalog.md +1 -1
  574. package/examples/@xmachines/play-vue-gallery-demo/variables/fetchCatalog.md +1 -1
  575. package/examples/@xmachines/play-vue-gallery-demo/variables/flightCatalog.md +1 -1
  576. package/examples/@xmachines/play-vue-gallery-demo/variables/galleryMachines.md +1 -1
  577. package/examples/@xmachines/play-vue-gallery-demo/variables/stopwatchCatalog.md +1 -1
  578. package/examples/@xmachines/play-vue-gallery-demo/variables/temperatureCatalog.md +1 -1
  579. package/examples/@xmachines/play-vue-gallery-demo/variables/ticTacToeCatalog.md +1 -1
  580. package/examples/@xmachines/play-vue-gallery-demo/variables/todoMvcCatalog.md +1 -1
  581. package/examples/@xmachines/play-vue-gallery-demo/variables/triviaCatalog.md +1 -1
  582. package/package.json +2 -1
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ParsedPattern
4
4
 
5
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L117)
5
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L117)
6
6
 
7
7
  Everything that this library reads from one route pattern.
8
8
 
@@ -10,14 +10,14 @@ Everything that this library reads from one route pattern.
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | --------------------------------------------------- | ---------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-bareform"></a> `bareForm` | `readonly` | `string` \| `null` | The path that the pattern matches when every optional part is absent, or `null` when the pattern holds a part that a path must fill. `/settings/:section?` gives `/settings`, `/a/{b}?/c` gives `/a//c`, and `/profile/:userId` gives `null`. | [packages/play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L154) |
14
- | <a id="property-declarednames"></a> `declaredNames` | `readonly` | `ReadonlyMap`\<`string`, `string`\> | The map from each rewritten group name back to the name that the pattern declares, for example `cat_id` to `cat-id`. The map holds an entry only for a name that the rewrite changed. It is empty for most patterns, and a caller that reads a group name falls back to the name itself. | [packages/play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L184) |
15
- | <a id="property-indexkey"></a> `indexKey` | `readonly` | `string` | The key of the bucket index: the first path segment, or `"*"` when a param can stand in the first segment. | [packages/play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L171) |
16
- | <a id="property-literalpath"></a> `literalPath` | `readonly` | `string` \| `null` | The ONE path that the pattern matches, with each escape resolved, or `null` when the pattern describes a SET of paths. `/users` gives `/users`, `/tags/c\+\+` gives `/tags/c++`, `/x{y}z` gives `/xyz`, and `/profile/:userId` gives `null`. A bridge writes a real browser URL from this field. The SOURCE of the pattern is no substitute for it: `/tags/c\+\+` carries two backslashes that the address bar must not hold, and a location that carries them matches the route never. | [packages/play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L166) |
17
- | <a id="property-names"></a> `names` | `readonly` | readonly `string`[] | The name of every param of [params](#property-params), in the same order. `resolveFrameworkParams` runs on EVERY navigation and it needs this list each time. The parse holds it, so a navigation allocates none. A caller that hands the array to somebody else copies it: the cache holds this one. | [packages/play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L131) |
18
- | <a id="property-normalized"></a> `normalized` | `readonly` | `string` | The pattern in the form that URLPattern compiles: each param name that holds a hyphen carries an underscore instead. | [packages/play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L176) |
19
- | <a id="property-parameterized"></a> `parameterized` | `readonly` | `boolean` | True when the pattern needs a URLPattern match, and false when it is a literal path. A malformed pattern reports `true`, so that it reaches the URLPattern constructor and fails there with the error of the API. A parser that called it static would send it to the exact-match map instead, where it matches nothing and reports no fault. | [packages/play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L146) |
20
- | <a id="property-params"></a> `params` | `readonly` | readonly [`PatternParam`](PatternParam.md)[] | The NAMED params, in the order that the pattern declares them. | [packages/play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L123) |
21
- | <a id="property-parts"></a> `parts` | `readonly` | readonly [`PatternPart`](../type-aliases/PatternPart.md)[] | The parts, in the order that the pattern declares them. | [packages/play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L121) |
22
- | <a id="property-requirednames"></a> `requiredNames` | `readonly` | readonly `string`[] | The name of every param that a path must fill, in the order of [params](#property-params). The same rule as [names](#property-names): the parse holds the array, and a navigation reads it. | [packages/play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L137) |
23
- | <a id="property-source"></a> `source` | `readonly` | `string` | The pattern as the caller wrote it. | [packages/play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L119) |
13
+ | <a id="property-bareform"></a> `bareForm` | `readonly` | `string` \| `null` | The path that the pattern matches when every optional part is absent, or `null` when the pattern holds a part that a path must fill. `/settings/:section?` gives `/settings`, `/a/{b}?/c` gives `/a//c`, and `/profile/:userId` gives `null`. | [packages/play-pattern/src/pattern-grammar.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L154) |
14
+ | <a id="property-declarednames"></a> `declaredNames` | `readonly` | `ReadonlyMap`\<`string`, `string`\> | The map from each rewritten group name back to the name that the pattern declares, for example `cat_id` to `cat-id`. The map holds an entry only for a name that the rewrite changed. It is empty for most patterns, and a caller that reads a group name falls back to the name itself. | [packages/play-pattern/src/pattern-grammar.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L184) |
15
+ | <a id="property-indexkey"></a> `indexKey` | `readonly` | `string` | The key of the bucket index: the first path segment, or `"*"` when a param can stand in the first segment. | [packages/play-pattern/src/pattern-grammar.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L171) |
16
+ | <a id="property-literalpath"></a> `literalPath` | `readonly` | `string` \| `null` | The ONE path that the pattern matches, with each escape resolved, or `null` when the pattern describes a SET of paths. `/users` gives `/users`, `/tags/c\+\+` gives `/tags/c++`, `/x{y}z` gives `/xyz`, and `/profile/:userId` gives `null`. A bridge writes a real browser URL from this field. The SOURCE of the pattern is no substitute for it: `/tags/c\+\+` carries two backslashes that the address bar must not hold, and a location that carries them matches the route never. | [packages/play-pattern/src/pattern-grammar.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L166) |
17
+ | <a id="property-names"></a> `names` | `readonly` | readonly `string`[] | The name of every param of [params](#property-params), in the same order. `resolveFrameworkParams` runs on EVERY navigation and it needs this list each time. The parse holds it, so a navigation allocates none. A caller that hands the array to somebody else copies it: the cache holds this one. | [packages/play-pattern/src/pattern-grammar.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L131) |
18
+ | <a id="property-normalized"></a> `normalized` | `readonly` | `string` | The pattern in the form that URLPattern compiles: each param name that holds a hyphen carries an underscore instead. | [packages/play-pattern/src/pattern-grammar.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L176) |
19
+ | <a id="property-parameterized"></a> `parameterized` | `readonly` | `boolean` | True when the pattern needs a URLPattern match, and false when it is a literal path. A malformed pattern reports `true`, so that it reaches the URLPattern constructor and fails there with the error of the API. A parser that called it static would send it to the exact-match map instead, where it matches nothing and reports no fault. | [packages/play-pattern/src/pattern-grammar.ts:146](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L146) |
20
+ | <a id="property-params"></a> `params` | `readonly` | readonly [`PatternParam`](PatternParam.md)[] | The NAMED params, in the order that the pattern declares them. | [packages/play-pattern/src/pattern-grammar.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L123) |
21
+ | <a id="property-parts"></a> `parts` | `readonly` | readonly [`PatternPart`](../type-aliases/PatternPart.md)[] | The parts, in the order that the pattern declares them. | [packages/play-pattern/src/pattern-grammar.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L121) |
22
+ | <a id="property-requirednames"></a> `requiredNames` | `readonly` | readonly `string`[] | The name of every param that a path must fill, in the order of [params](#property-params). The same rule as [names](#property-names): the parse holds the array, and a navigation reads it. | [packages/play-pattern/src/pattern-grammar.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L137) |
23
+ | <a id="property-source"></a> `source` | `readonly` | `string` | The pattern as the caller wrote it. | [packages/play-pattern/src/pattern-grammar.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L119) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PatternParam
4
4
 
5
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L101)
5
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L101)
6
6
 
7
7
  One named param of a pattern, with the question that every caller asks about it.
8
8
 
@@ -10,6 +10,6 @@ One named param of a pattern, with the question that every caller asks about it.
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ------------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-groupname"></a> `groupName` | `readonly` | `string` | The name that URLPattern compiles, for example `cat_id`. | [packages/play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L105) |
14
- | <a id="property-name"></a> `name` | `readonly` | `string` | The name as the pattern declares it, for example `cat-id`. | [packages/play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L103) |
15
- | <a id="property-optional"></a> `optional` | `readonly` | `boolean` | True when a matching path can carry no value for this param. The modifier `?` and the modifier `*` make a param optional, and so does EVERY group above it that carries one of the two. The modifier `+` does not: it repeats a param that one value must still fill. | [packages/play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L113) |
13
+ | <a id="property-groupname"></a> `groupName` | `readonly` | `string` | The name that URLPattern compiles, for example `cat_id`. | [packages/play-pattern/src/pattern-grammar.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L105) |
14
+ | <a id="property-name"></a> `name` | `readonly` | `string` | The name as the pattern declares it, for example `cat-id`. | [packages/play-pattern/src/pattern-grammar.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L103) |
15
+ | <a id="property-optional"></a> `optional` | `readonly` | `boolean` | True when a matching path can carry no value for this param. The modifier `?` and the modifier `*` make a param optional, and so does EVERY group above it that carries one of the two. The modifier `+` does not: it repeats a param that one value must still fill. | [packages/play-pattern/src/pattern-grammar.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L113) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ResolvedBasePath
4
4
 
5
- Defined in: [packages/play-url/src/base-path.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L82)
5
+ Defined in: [packages/play-url/src/base-path.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/base-path.ts#L82)
6
6
 
7
7
  A base path that is ready for a use in both directions.
8
8
 
@@ -10,5 +10,5 @@ A base path that is ready for a use in both directions.
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-params"></a> `params` | `readonly` | `Record`\<`string`, `string`\> | The values of each `:param` of the prefix, for the `params` of a `play.route` event. The object is empty for a prefix without a param, and for a pattern that nothing resolved. | [packages/play-url/src/base-path.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L93) |
14
- | <a id="property-path"></a> `path` | `readonly` | `string` | The normalized prefix: it starts with `/`, it carries no trailing `/`, and it holds no duplicate slash. The empty string means "no prefix". | [packages/play-url/src/base-path.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L87) |
13
+ | <a id="property-params"></a> `params` | `readonly` | `Record`\<`string`, `string`\> | The values of each `:param` of the prefix, for the `params` of a `play.route` event. The object is empty for a prefix without a param, and for a pattern that nothing resolved. | [packages/play-url/src/base-path.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/base-path.ts#L93) |
14
+ | <a id="property-path"></a> `path` | `readonly` | `string` | The normalized prefix: it starts with `/`, it carries no trailing `/`, and it holds no duplicate slash. The empty string means "no prefix". | [packages/play-url/src/base-path.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/base-path.ts#L87) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SplitLocation
4
4
 
5
- Defined in: [packages/play-url/src/location.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/location.ts#L17)
5
+ Defined in: [packages/play-url/src/location.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/location.ts#L17)
6
6
 
7
7
  The parts of one location string.
8
8
 
@@ -10,7 +10,7 @@ The parts of one location string.
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ----------------------------------------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-fragment"></a> `fragment` | `readonly` | `string` | The fragment, WITH its leading `#`. It is `""` when the location carries none. | [packages/play-url/src/location.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/location.ts#L23) |
14
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | The pathname, with no query and no fragment. | [packages/play-url/src/location.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/location.ts#L19) |
15
- | <a id="property-query"></a> `query` | `readonly` | `string` | The query, with no leading `?`. It is `""` when the location carries none. | [packages/play-url/src/location.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/location.ts#L21) |
16
- | <a id="property-suffix"></a> `suffix` | `readonly` | `string` | Every character behind the pathname, as the location wrote them. A caller that rebuilds a location keeps this string rather than the two parts above, because it carries the `?` and the order of the two marks without a change. | [packages/play-url/src/location.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/location.ts#L30) |
13
+ | <a id="property-fragment"></a> `fragment` | `readonly` | `string` | The fragment, WITH its leading `#`. It is `""` when the location carries none. | [packages/play-url/src/location.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/location.ts#L23) |
14
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | The pathname, with no query and no fragment. | [packages/play-url/src/location.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/location.ts#L19) |
15
+ | <a id="property-query"></a> `query` | `readonly` | `string` | The query, with no leading `?`. It is `""` when the location carries none. | [packages/play-url/src/location.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/location.ts#L21) |
16
+ | <a id="property-suffix"></a> `suffix` | `readonly` | `string` | Every character behind the pathname, as the location wrote them. A caller that rebuilds a location keeps this string rather than the two parts above, because it carries the `?` and the order of the two marks without a change. | [packages/play-url/src/location.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/location.ts#L30) |
@@ -21,7 +21,7 @@ type PathBuildResult =
21
21
  };
22
22
  ```
23
23
 
24
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:651](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L651)
24
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:651](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L651)
25
25
 
26
26
  The answer of [buildPath](../functions/buildPath.md).
27
27
 
@@ -6,7 +6,7 @@
6
6
  type PathParams = Readonly<Record<string, unknown>>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L681)
9
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:681](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L681)
10
10
 
11
11
  The values that a caller gives, keyed by the declared name of the param.
12
12
 
@@ -6,6 +6,6 @@
6
6
  type PatternModifier = "" | "?" | "+" | "*";
7
7
  ```
8
8
 
9
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L56)
9
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L56)
10
10
 
11
11
  The modifier of a part. `""` means that the part carries none.
@@ -6,4 +6,4 @@
6
6
  type PatternPart = LiteralPart | ParamPart | GroupPart;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-pattern/src/pattern-grammar.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-pattern/src/pattern-grammar.ts#L98)
9
+ Defined in: [packages/play-pattern/src/pattern-grammar.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-pattern/src/pattern-grammar.ts#L98)
@@ -6,7 +6,7 @@
6
6
  type URLPatternCtor = new (init) => URLPatternLike;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L59)
9
+ Defined in: [packages/play-url/src/url-pattern-utils.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/url-pattern-utils.ts#L59)
10
10
 
11
11
  The constructor type of a URLPatternLike instance.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type URLPatternLike = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L51)
9
+ Defined in: [packages/play-url/src/url-pattern-utils.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/url-pattern-utils.ts#L51)
10
10
 
11
11
  The minimal structural type of the part of URLPattern that this package uses.
12
12
 
@@ -28,7 +28,7 @@ exec(input):
28
28
  | null;
29
29
  ```
30
30
 
31
- Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L52)
31
+ Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/url-pattern-utils.ts#L52)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -54,7 +54,7 @@ Defined in: [packages/play-url/src/url-pattern-utils.ts:52](https://gitlab.com/x
54
54
  test(input): boolean;
55
55
  ```
56
56
 
57
- Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L55)
57
+ Defined in: [packages/play-url/src/url-pattern-utils.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/url-pattern-utils.ts#L55)
58
58
 
59
59
  #### Parameters
60
60
 
@@ -6,7 +6,7 @@
6
6
  const NO_BASE_PATH: ResolvedBasePath;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/base-path.ts#L106)
9
+ Defined in: [packages/play-url/src/base-path.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/base-path.ts#L106)
10
10
 
11
11
  The base path of a bridge that has no `basePath` option.
12
12
 
@@ -6,7 +6,7 @@
6
6
  const URLPattern: URLPatternCtor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-url/src/url-pattern-utils.ts#L74)
9
+ Defined in: [packages/play-url/src/url-pattern-utils.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-url/src/url-pattern-utils.ts#L74)
10
10
 
11
11
  The URLPattern constructor that this library uses: the native API when the runtime
12
12
  carries one, and the polyfill when it does not.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidViewOutletError
4
4
 
5
- Defined in: [packages/play-view/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L81)
5
+ Defined in: [packages/play-view/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L81)
6
6
 
7
7
  An outlet of a `meta.view` names an element that the view does not hold.
8
8
 
@@ -47,7 +47,7 @@ new InvalidViewOutletError(
47
47
  ): InvalidViewOutletError;
48
48
  ```
49
49
 
50
- Defined in: [packages/play-view/src/errors.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L92)
50
+ Defined in: [packages/play-view/src/errors.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L92)
51
51
 
52
52
  #### Parameters
53
53
 
@@ -70,13 +70,13 @@ Defined in: [packages/play-view/src/errors.ts:92](https://gitlab.com/xmachin-es/
70
70
  | Property | Modifier | Type | Description | Inherited from | Defined in |
71
71
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
72
72
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
73
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L56) |
73
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L56) |
74
74
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
75
75
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
76
- | <a id="property-outlet"></a> `outlet` | `readonly` | `string` | The key of the outlet: a child state key, or `"*"`. | - | [packages/play-view/src/errors.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L85) |
77
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L46) |
76
+ | <a id="property-outlet"></a> `outlet` | `readonly` | `string` | The key of the outlet: a child state key, or `"*"`. | - | [packages/play-view/src/errors.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L85) |
77
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L46) |
78
78
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
79
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The id of the state node whose `meta.view` declares the outlet. | - | [packages/play-view/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L83) |
79
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The id of the state node whose `meta.view` declares the outlet. | - | [packages/play-view/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L83) |
80
80
  | <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) | - |
81
81
 
82
82
  ## Methods
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReadOnlyContextError
4
4
 
5
- Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L34)
5
+ Defined in: [packages/play-view/src/errors.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L34)
6
6
 
7
7
  A write reached the context projection of the view store.
8
8
 
@@ -37,7 +37,7 @@ try {
37
37
  new ReadOnlyContextError(path, stateKey): ReadOnlyContextError;
38
38
  ```
39
39
 
40
- Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L42)
40
+ Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L42)
41
41
 
42
42
  #### Parameters
43
43
 
@@ -59,11 +59,11 @@ Defined in: [packages/play-view/src/errors.ts:42](https://gitlab.com/xmachin-es/
59
59
  | Property | Modifier | Type | Description | Inherited from | Defined in |
60
60
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
61
61
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
62
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L56) |
62
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L56) |
63
63
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
64
64
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
65
- | <a id="property-path"></a> `path` | `readonly` | `string` | The JSON pointer of the write that the store refused, as the caller gave it. | - | [packages/play-view/src/errors.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L36) |
66
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L46) |
65
+ | <a id="property-path"></a> `path` | `readonly` | `string` | The JSON pointer of the write that the store refused, as the caller gave it. | - | [packages/play-view/src/errors.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L36) |
66
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L46) |
67
67
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
68
68
  | <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) | - |
69
69
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ViewElementKeyCollisionError
4
4
 
5
- Defined in: [packages/play-view/src/errors.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L115)
5
+ Defined in: [packages/play-view/src/errors.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L115)
6
6
 
7
7
  Two views of one composition hold an element with the same key.
8
8
 
@@ -25,7 +25,7 @@ through its `onError` option and keeps the last good view.
25
25
  new ViewElementKeyCollisionError(stateId, key): ViewElementKeyCollisionError;
26
26
  ```
27
27
 
28
- Defined in: [packages/play-view/src/errors.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L125)
28
+ Defined in: [packages/play-view/src/errors.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L125)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -47,13 +47,13 @@ Defined in: [packages/play-view/src/errors.ts:125](https://gitlab.com/xmachin-es
47
47
  | Property | Modifier | Type | Description | Inherited from | Defined in |
48
48
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
49
49
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
50
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L56) |
51
- | <a id="property-key"></a> `key` | `readonly` | `string` | The key of the element in the composed spec. | - | [packages/play-view/src/errors.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L119) |
50
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code 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/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L56) |
51
+ | <a id="property-key"></a> `key` | `readonly` | `string` | The key of the element in the composed spec. | - | [packages/play-view/src/errors.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L119) |
52
52
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
53
53
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
54
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/core/src/errors.ts#L46) |
54
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/core/src/errors.ts#L46) |
55
55
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
56
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The id of the state node whose view declares the second element. | - | [packages/play-view/src/errors.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/errors.ts#L117) |
56
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The id of the state node whose view declares the second element. | - | [packages/play-view/src/errors.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/errors.ts#L117) |
57
57
  | <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) | - |
58
58
 
59
59
  ## Methods
@@ -6,7 +6,7 @@
6
6
  function attachRenderErrorHandler<TRegistry>(registry, handler): TRegistry;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/provider-guards.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/provider-guards.ts#L78)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/provider-guards.ts#L78)
10
10
 
11
11
  Copies a component registry, and puts an `onRenderError` handler into the copy.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function bindStoreHandlers<THandlers>(registryResult, getStore): THandlers;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/provider-guards.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/provider-guards.ts#L218)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/provider-guards.ts#L218)
10
10
 
11
11
  Builds the action handlers of a registry against a state store.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function composePlayState(authoredState, slice): Record<string, unknown> | undefined;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/context-projection.ts#L207)
9
+ Defined in: [packages/play-view/src/context-projection.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/context-projection.ts#L207)
10
10
 
11
11
  Composes the effective state of a view: the authored `spec.state` and the
12
12
  `/context` slice.
@@ -6,7 +6,7 @@
6
6
  function composeViews(tree): ComposedView;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/compose-views.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/compose-views.ts#L173)
9
+ Defined in: [packages/play-view/src/compose-views.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/compose-views.ts#L173)
10
10
 
11
11
  Grafts the views of a [ViewTree](../interfaces/ViewTree.md) into one flat spec.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createActorProxy<TActor>(getActor): TActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/actor-proxy.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/actor-proxy.ts#L32)
9
+ Defined in: [packages/play-view/src/actor-proxy.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/actor-proxy.ts#L32)
10
10
 
11
11
  Makes a proxy that behaves like the current actor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRenderErrorBinding<TResult>(): (result, handler, onRootFailure?) => TResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/provider-guards.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/provider-guards.ts#L160)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/provider-guards.ts#L160)
10
10
 
11
11
  Makes a binding of an `onRenderError` handler to a registry result, for one provider.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createReportGuard(messages): ReportGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/report-guard.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/report-guard.ts#L98)
9
+ Defined in: [packages/play-view/src/report-guard.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/report-guard.ts#L98)
10
10
 
11
11
  Makes a [ReportGuard](../interfaces/ReportGuard.md).
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createViewSession<TActor>(actor, store, options): ViewSession<TActor>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/view-session.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/view-session.ts#L152)
9
+ Defined in: [packages/play-view/src/view-session.ts:152](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/view-session.ts#L152)
10
10
 
11
11
  Makes a view session.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createViewStoreLifecycle(createStore): ViewStoreLifecycle;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/view-store-lifecycle.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/view-store-lifecycle.ts#L135)
9
+ Defined in: [packages/play-view/src/view-store-lifecycle.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/view-store-lifecycle.ts#L135)
10
10
 
11
11
  Creates a coordinator of the lifecycle.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function forwardRenderError(handler, registry, error, name, info): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/provider-guards.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/provider-guards.ts#L116)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/provider-guards.ts#L116)
10
10
 
11
11
  Gives one report of json-render to the handler of the host, and tells the caller
12
12
  whether the report is a failure of the root.
@@ -6,7 +6,7 @@
6
6
  function guardContextWrites(store): StateStore;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/context-projection.ts#L136)
9
+ Defined in: [packages/play-view/src/context-projection.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/context-projection.ts#L136)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function refreshContextSubtree(store, view): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/context-projection.ts#L189)
9
+ Defined in: [packages/play-view/src/context-projection.ts:189](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/context-projection.ts#L189)
10
10
 
11
11
  Refreshes the `/context` subtree of a live store from the composed state of a
12
12
  derived view. An emission with the same `viewKey` means that only the projection
@@ -6,7 +6,7 @@
6
6
  function reuseComposedState(prev, next): PlaySpec | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/context-projection.ts#L72)
9
+ Defined in: [packages/play-view/src/context-projection.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/context-projection.ts#L72)
10
10
 
11
11
  Reuses the composed `state` of the previous emission, or the complete previous
12
12
  spec, when the value of the projection did not change.
@@ -6,7 +6,7 @@
6
6
  function toAtomState(state): Record<string, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/provider-guards.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.3.0/packages/play-view/src/provider-guards.ts#L47)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.1/packages/play-view/src/provider-guards.ts#L47)
10
10
 
11
11
  Converts the `state` field of a spec into a plain object for `createAtom`, in a safe way.
12
12