@xmachines/docs 5.0.1 → 6.0.0

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 (564) hide show
  1. package/README.md +4 -1
  2. package/api/@xmachines/core/README.md +209 -0
  3. package/api/@xmachines/core/cache/README.md +17 -0
  4. package/api/@xmachines/core/cache/functions/createLruCache.md +52 -0
  5. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +61 -0
  6. package/api/@xmachines/core/errors/README.md +11 -0
  7. package/api/@xmachines/core/errors/classes/BaseError.md +226 -0
  8. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +177 -0
  9. package/api/@xmachines/core/utils/README.md +33 -0
  10. package/api/@xmachines/core/utils/functions/asDisposable.md +139 -0
  11. package/api/@xmachines/core/utils/functions/createNullRecord.md +39 -0
  12. package/api/@xmachines/core/utils/functions/createWarnOnce.md +39 -0
  13. package/api/@xmachines/core/utils/functions/describeValue.md +39 -0
  14. package/api/@xmachines/core/utils/functions/isError.md +46 -0
  15. package/api/@xmachines/core/utils/functions/isThenable.md +43 -0
  16. package/api/@xmachines/core/utils/functions/releaseQuietly.md +37 -0
  17. package/api/@xmachines/core/utils/functions/rethrowLater.md +43 -0
  18. package/api/@xmachines/core/utils/functions/safeString.md +36 -0
  19. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +42 -0
  20. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +28 -0
  21. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +14 -0
  22. package/api/@xmachines/{play-router/index → core/utils}/variables/DISPOSE.md +9 -9
  23. package/api/@xmachines/play/README.md +19 -70
  24. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  25. package/api/@xmachines/play/errors/classes/PlayError.md +30 -34
  26. package/api/@xmachines/play/index/README.md +0 -8
  27. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  28. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  29. package/api/@xmachines/play-actor/README.md +1 -1
  30. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  31. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  32. package/api/@xmachines/play-atom/README.md +35 -26
  33. package/api/@xmachines/play-atom/functions/watchAtom.md +8 -8
  34. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  35. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  36. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +6 -6
  37. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +4 -4
  38. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  39. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  40. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  41. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  42. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  43. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  44. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  45. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  46. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  47. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  48. package/api/@xmachines/play-dom/README.md +32 -34
  49. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  50. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  51. package/api/@xmachines/play-dom/functions/createRenderer.md +3 -3
  52. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +11 -11
  53. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  54. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -14
  55. package/api/@xmachines/play-dom/type-aliases/MountFn.md +6 -17
  56. package/api/@xmachines/play-dom-router/README.md +35 -49
  57. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +13 -13
  58. package/api/@xmachines/play-dom-router/classes/RouteMap.md +5 -6
  59. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  60. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +5 -3
  61. package/api/@xmachines/play-dom-router/functions/createRouter.md +5 -3
  62. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  63. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +21 -67
  64. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  65. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  66. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  67. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  68. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  69. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  70. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  71. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
  72. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +12 -31
  73. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +12 -27
  74. package/api/@xmachines/play-pattern/README.md +10 -6
  75. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  76. package/api/@xmachines/play-pattern/functions/{createPatternCache.md → createLruCache.md} +19 -14
  77. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  78. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  79. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  80. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  81. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +61 -0
  82. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  83. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  84. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  85. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  86. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  87. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  88. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  89. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  90. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  91. package/api/@xmachines/play-react/README.md +5 -5
  92. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  93. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  94. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  95. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  96. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +10 -10
  97. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  98. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  99. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  100. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  101. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  102. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  103. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  104. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  105. package/api/@xmachines/play-react-router/README.md +5 -3
  106. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  107. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -6
  108. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  109. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  110. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  111. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  112. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  113. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  114. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  115. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
  116. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  117. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  118. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  119. package/api/@xmachines/play-router/README.md +15 -14
  120. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  121. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  122. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  123. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  124. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  125. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  126. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  127. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  128. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  129. package/api/@xmachines/play-router/index/README.md +2 -3
  130. package/api/@xmachines/play-router/index/classes/RouteMap.md +5 -6
  131. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  132. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/{createPatternCache.md → createLruCache.md} +19 -14
  136. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +3 -3
  143. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  144. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  148. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  154. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  155. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  156. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  158. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  159. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  160. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  161. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  162. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +61 -0
  163. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  164. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  165. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +10 -10
  166. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  167. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  168. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  169. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +11 -11
  170. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  171. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  172. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  173. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  174. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  175. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  176. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  178. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  179. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +5 -5
  180. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  181. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  182. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +5 -5
  183. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +7 -7
  184. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +12 -31
  185. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  186. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  187. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  188. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  189. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  190. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  191. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  192. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  193. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  195. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  196. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  198. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  199. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  200. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  201. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  202. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  203. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  204. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  205. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  206. package/api/@xmachines/play-solid/README.md +2 -2
  207. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  208. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  209. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  210. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  211. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  212. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  213. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  214. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  215. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  216. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  217. package/api/@xmachines/play-solid-router/README.md +5 -3
  218. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -6
  219. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  220. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  221. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  223. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  224. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  226. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  227. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
  228. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  230. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  231. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  232. package/api/@xmachines/play-svelte/README.md +4 -4
  233. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  236. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  237. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +10 -10
  238. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  239. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +13 -13
  240. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  241. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  242. package/api/@xmachines/play-svelte-spa-router/README.md +5 -3
  243. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -6
  244. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  245. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
  253. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +12 -31
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  255. package/api/@xmachines/play-sveltekit-router/README.md +5 -3
  256. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -6
  257. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  258. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  259. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  260. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +10 -10
  261. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  262. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  263. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  266. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
  267. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +12 -31
  268. package/api/@xmachines/play-tanstack-react-router/README.md +5 -3
  269. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -6
  270. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  271. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  272. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  282. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  283. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  284. package/api/@xmachines/play-tanstack-router/README.md +11 -1
  285. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  286. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  287. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  288. package/api/@xmachines/play-tanstack-solid-router/README.md +5 -3
  289. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -6
  290. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  291. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
  298. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  302. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  303. package/api/@xmachines/play-url/README.md +3 -3
  304. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  305. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  306. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  307. package/api/@xmachines/play-url/index/README.md +2 -2
  308. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  309. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  310. package/api/@xmachines/play-url/index/functions/{createPatternCache.md → createLruCache.md} +19 -14
  311. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  312. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  313. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  314. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  315. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  316. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  317. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  318. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  319. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  320. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  321. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  322. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  323. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  324. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  325. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +3 -3
  326. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  327. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  328. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  329. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +61 -0
  330. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +3 -3
  331. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +7 -7
  332. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  333. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +12 -12
  334. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +4 -4
  335. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +3 -3
  336. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +5 -5
  337. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  338. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  339. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  340. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  341. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  342. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  343. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  344. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  345. package/api/@xmachines/play-view/README.md +4 -3
  346. package/api/@xmachines/play-view/errors/README.md +1 -1
  347. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  348. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  349. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  350. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  353. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +2 -2
  356. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  359. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  360. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  361. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +3 -3
  362. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +2 -2
  363. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  364. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  365. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  366. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +4 -4
  367. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +3 -3
  368. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +4 -4
  369. package/api/@xmachines/play-view/index/interfaces/Viewable.md +2 -2
  370. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  371. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  372. package/api/@xmachines/play-vue/README.md +4 -4
  373. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  374. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  375. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  376. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  377. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -0
  378. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  379. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  380. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  381. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  382. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  383. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  384. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  385. package/api/@xmachines/play-vue/variables/schema.md +35 -54
  386. package/api/@xmachines/play-vue-router/README.md +4 -2
  387. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  388. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  389. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +5 -6
  390. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  391. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  392. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  393. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  394. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  395. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +5 -5
  396. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +7 -7
  397. package/api/@xmachines/play-xstate/README.md +20 -9
  398. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  399. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  400. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  401. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  402. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  403. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  404. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  405. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  406. package/api/@xmachines/play-xstate/index/README.md +0 -4
  407. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -45
  408. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  409. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  410. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  411. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  412. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  413. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  414. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  415. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  416. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  417. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  418. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  419. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  420. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  421. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  422. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +5 -5
  423. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  424. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  425. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  426. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  427. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  428. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  429. package/api/@xmachines/shared/README.md +1 -1
  430. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  431. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  432. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  433. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  434. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  435. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  436. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  437. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  438. package/api/README.md +1 -0
  439. package/api/llms.txt +1 -0
  440. package/contributing/architecture.md +36 -21
  441. package/contributing/configuration.md +7 -5
  442. package/contributing/deployment.md +23 -7
  443. package/contributing/development.md +26 -27
  444. package/contributing/migrating-to-play-atom.md +2 -1
  445. package/examples/@xmachines/play-dom-demo/README.md +6 -2
  446. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +9 -9
  447. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  448. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  449. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  450. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  451. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  452. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  453. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  454. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  455. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  456. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  457. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  464. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  465. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  466. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +17 -17
  467. package/examples/@xmachines/play-dom-router-demo/README.md +9 -10
  468. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +9 -9
  469. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  470. package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
  471. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  472. package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
  473. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
  474. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  475. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  476. package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
  477. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  478. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
  481. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
  484. package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
  485. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  486. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  487. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  488. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +17 -17
  489. package/examples/@xmachines/play-react-router-demo/README.md +1 -1
  490. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +9 -9
  491. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  492. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  493. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  494. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  495. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  496. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  497. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  498. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  499. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  506. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  507. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  508. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  509. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  510. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  511. package/examples/@xmachines/play-solid-router-demo/README.md +1 -1
  512. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +9 -9
  513. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  514. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  515. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +15 -15
  516. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +1 -1
  517. package/examples/@xmachines/play-sveltekit-router-demo/README.md +1 -1
  518. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +1 -1
  519. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +1 -1
  520. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +9 -9
  521. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  522. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  523. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +190 -277
  524. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  525. package/examples/README.md +1 -1
  526. package/examples/form-validation.md +6 -3
  527. package/examples/multi-router-integration.md +6 -3
  528. package/examples/routing-patterns.md +6 -3
  529. package/guides/atoms.md +24 -12
  530. package/guides/getting-started.md +20 -14
  531. package/package.json +2 -1
  532. package/rfc/broker.md +4 -0
  533. package/rfc/browser.md +4 -0
  534. package/rfc/cli.md +4 -0
  535. package/rfc/git.md +4 -0
  536. package/rfc/mcp.md +4 -0
  537. package/rfc/node.md +4 -0
  538. package/rfc/play.md +1 -1
  539. package/rfc/rest.md +4 -0
  540. package/rfc/run.md +4 -0
  541. package/rfc/streams.md +4 -0
  542. package/api/@xmachines/play/index/functions/asCleanup.md +0 -77
  543. package/api/@xmachines/play/index/functions/shallowEqualExcept.md +0 -29
  544. package/api/@xmachines/play/index/type-aliases/Cleanup.md +0 -38
  545. package/api/@xmachines/play/index/type-aliases/DisposeKey.md +0 -32
  546. package/api/@xmachines/play/index/variables/DISPOSE.md +0 -34
  547. package/api/@xmachines/play-atom/type-aliases/Cleanup.md +0 -38
  548. package/api/@xmachines/play-dom/functions/asCleanup.md +0 -77
  549. package/api/@xmachines/play-dom/type-aliases/Cleanup.md +0 -38
  550. package/api/@xmachines/play-dom-router/functions/asCleanup.md +0 -77
  551. package/api/@xmachines/play-dom-router/type-aliases/Cleanup.md +0 -38
  552. package/api/@xmachines/play-dom-router/variables/DISPOSE.md +0 -34
  553. package/api/@xmachines/play-pattern/interfaces/PatternCache.md +0 -65
  554. package/api/@xmachines/play-router/index/interfaces/PatternCache.md +0 -65
  555. package/api/@xmachines/play-url/index/interfaces/PatternCache.md +0 -65
  556. package/api/@xmachines/play-xstate/index/variables/DISPOSE.md +0 -34
  557. package/examples/@xmachines/play-react-demo/functions/App.md +0 -13
  558. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +0 -20
  559. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +0 -20
  560. package/examples/@xmachines/play-react-demo/functions/Shell.md +0 -22
  561. package/examples/@xmachines/play-solid-demo/functions/App.md +0 -13
  562. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +0 -20
  563. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +0 -20
  564. package/examples/@xmachines/play-solid-demo/functions/Shell.md +0 -22
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ParseOptions
4
4
 
5
- Defined in: [packages/play-pattern/src/cache.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L34)
5
+ Defined in: [packages/play-pattern/src/cache.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-pattern/src/cache.ts#L35)
6
6
 
7
7
  The options that every read of the pattern language takes.
8
8
 
@@ -19,6 +19,6 @@ positional argument gave each layer a different position to remember.
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Modifier | Type | Description | Defined in |
23
- | -------------------------------------------------- | ---------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`PatternCache`](PatternCache.md)\<[`ParsedPattern`](ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [packages/play-pattern/src/cache.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-pattern/src/cache.ts#L40) |
22
+ | Property | Modifier | Type | Description | Defined in |
23
+ | -------------------------------------------------- | ---------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](KeyValueCache.md)\<[`ParsedPattern`](ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [packages/play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-pattern/src/cache.ts#L41) |
@@ -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/v5.0.1/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/v6.0.0/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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.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/v5.0.1/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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.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/v5.0.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/v5.0.1/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/v6.0.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/v6.0.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/v6.0.0/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/v5.0.1/packages/play-url/src/base-path.ts#L82)
5
+ Defined in: [packages/play-url/src/base-path.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L83)
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/v5.0.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/v5.0.1/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:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L94) |
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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L88) |
@@ -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/v5.0.1/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/v6.0.0/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/v5.0.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/v5.0.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/v5.0.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/v5.0.1/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/v6.0.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/v6.0.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/v6.0.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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/packages/play-pattern/src/pattern-grammar.ts#L98)
@@ -6,7 +6,7 @@
6
6
  type URLPatternCtor = (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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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/v5.0.1/packages/play-url/src/base-path.ts#L106)
9
+ Defined in: [packages/play-url/src/base-path.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/base-path.ts#L107)
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/v5.0.1/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/v6.0.0/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.
@@ -4,7 +4,7 @@
4
4
 
5
5
  The shared view half of every renderer of the XMachines Play Architecture.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-5.0.1-blue)](https://www.npmjs.com/package/@xmachines/play-view)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-view)
8
8
 
9
9
  ## Installation
10
10
 
@@ -15,10 +15,11 @@ pnpm add @xmachines/play-view
15
15
  **Peer dependencies.** Install them with the package:
16
16
 
17
17
  ```bash
18
- pnpm add @xmachines/json-render-core @xmachines/play @xmachines/play-atom
18
+ pnpm add @xmachines/core @xmachines/json-render-core @xmachines/play @xmachines/play-atom
19
19
  ```
20
20
 
21
- - [`@xmachines/play`](../play/README.md) — the core protocol. This package reads `shallowEqualExcept` from it.
21
+ - [`@xmachines/core`](../core/README.md) — the base package. This package reads the helpers of its `utils` subpath.
22
+ - [`@xmachines/play`](../play/README.md) — the core protocol. This package reads the error classes from its `errors` subpath.
22
23
  - [`@xmachines/play-atom`](../play-atom/README.md) — the atom primitives. The view store holds the spec in a `ReadonlyAtom`.
23
24
  - `@xmachines/json-render-core` — the spec type that `PlaySpec` extends.
24
25
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  The errors of the view half.
6
6
 
7
- Every error of this workspace extends `PlayError` of `@xmachines/play`, and it carries
7
+ Every error of a Play package extends `PlayError` of `@xmachines/play`, and it carries
8
8
  a `scope` and a `code` that stay the same across a patch release and a minor release.
9
9
  Match on the `code`, or on the class. Match on the `message` never.
10
10
 
@@ -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/v5.0.1/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/v6.0.0/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/v5.0.1/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/v6.0.0/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 `PLAY_<PACKAGE>_<DESCRIPTION>`. It stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/play/src/errors.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L76) |
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/v6.0.0/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/v5.0.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 `"RouterBridgeBase"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/play/src/errors.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play/src/errors.ts#L66) |
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/v6.0.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/v6.0.0/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
 
@@ -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:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/provider-guards.ts#L68)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/provider-guards.ts#L68)
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 composePlayState(authoredState, slice): Record<string, unknown> | undefined;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L208)
9
+ Defined in: [packages/play-view/src/context-projection.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/context-projection.ts#L203)
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 createFailureLatch(): FailureLatch;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L202)
9
+ Defined in: [packages/play-view/src/failure-latch.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L202)
10
10
 
11
11
  Makes a [FailureLatch](../interfaces/FailureLatch.md).
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createReportGuard(messages): ReportGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L134)
9
+ Defined in: [packages/play-view/src/failure-latch.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L134)
10
10
 
11
11
  Makes a [ReportGuard](../interfaces/ReportGuard.md).
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:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-store-lifecycle.ts#L94)
9
+ Defined in: [packages/play-view/src/view-store-lifecycle.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-store-lifecycle.ts#L94)
10
10
 
11
11
  Creates a coordinator of the lifecycle.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function guardContextWrites(store): StateStore;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/context-projection.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L137)
9
+ Defined in: [packages/play-view/src/context-projection.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/context-projection.ts#L132)
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:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L190)
9
+ Defined in: [packages/play-view/src/context-projection.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/context-projection.ts#L185)
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:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/context-projection.ts#L73)
9
+ Defined in: [packages/play-view/src/context-projection.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/context-projection.ts#L68)
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.
@@ -16,7 +16,7 @@ on each call, and the XState function `assign` makes a new context object on
16
16
  every event. Without this reuse, every event therefore presents a new `state`
17
17
  reference, and the `Object.is` test of each field in the emit gate emits the view
18
18
  again and remounts it, without an end. The function compares the slices field by
19
- field ([shallowEqualExcept](../../../play/index/functions/shallowEqualExcept.md)), because the XState function `assign` makes a
19
+ field ([shallowEqualExcept](../../../core/utils/functions/shallowEqualExcept.md)), because the XState function `assign` makes a
20
20
  new context object for each event, and a test of the identity of the whole object
21
21
  therefore reports a change every time. The authored fields come from the static
22
22
  `meta.view.state` through a spread. Therefore their references are stable for an
@@ -6,7 +6,7 @@
6
6
  function sameViewInputs(a, b): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/failure-latch.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L45)
9
+ Defined in: [packages/play-view/src/failure-latch.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L45)
10
10
 
11
11
  Answers whether two sets of inputs are the SAME attempt.
12
12
 
@@ -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:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/provider-guards.ts#L39)
9
+ Defined in: [packages/play-view/src/provider-guards.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/provider-guards.ts#L39)
10
10
 
11
11
  Converts the `state` field of a spec into a plain object for `createAtom`, in a safe way.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function typedSpec(spec): PlaySpec;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-view/src/view-types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L76)
9
+ Defined in: [packages/play-view/src/view-types.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L76)
10
10
 
11
11
  The identity helper gives a view spec literal the type `PlaySpec` at the
12
12
  definition site. The compiler therefore checks the spec, and the IDE completes it.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseActorProviderProps\<TRegistry, TActor\>
4
4
 
5
- Defined in: [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L164)
5
+ Defined in: [packages/play-view/src/view-types.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L164)
6
6
 
7
7
  The framework-agnostic base props. Every `ActorProvider` implementation shares
8
8
  them: React, Vue, Solid, and Svelte. `TRegistry` holds the
@@ -43,7 +43,7 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
43
43
 
44
44
  | Property | Type | Description | Defined in |
45
45
  | ----------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
46
- | <a id="property-actor"></a> `actor` | `TActor` | The actor instance with the currentView atom. It requires the Viewable capability. | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L169) |
47
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L183) |
48
- | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [packages/play-view/src/view-types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L171) |
49
- | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L178) |
46
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor instance with the currentView atom. It requires the Viewable capability. | [packages/play-view/src/view-types.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L169) |
47
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../../play-dom/type-aliases/RenderErrorHandler.md) | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | [packages/play-view/src/view-types.ts:183](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L183) |
48
+ | <a id="property-registryresult"></a> `registryResult` | `TRegistry` | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | [packages/play-view/src/view-types.ts:171](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L171) |
49
+ | <a id="property-store"></a> `store?` | `StateStore` | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | [packages/play-view/src/view-types.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L178) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseViewContextValue\<TRegistry\>
4
4
 
5
- Defined in: [packages/play-view/src/view-types.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L108)
5
+ Defined in: [packages/play-view/src/view-types.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L108)
6
6
 
7
7
  The framework-agnostic base of the `ViewContextValue` type in each framework.
8
8
 
@@ -28,7 +28,7 @@ same generic parameter as in `BaseActorProviderProps`.
28
28
 
29
29
  | Property | Type | Description | Defined in |
30
30
  | ----------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
31
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [packages/play-view/src/view-types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L112) |
32
- | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [packages/play-view/src/view-types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L114) |
33
- | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-view/src/view-types.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L110) |
34
- | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/view-types.ts#L118) |
31
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | The action handlers, resolved against the live StateStore. | [packages/play-view/src/view-types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L112) |
32
+ | <a id="property-registry"></a> `registry` | `TRegistry` | The component registry, from registryResult.registry. | [packages/play-view/src/view-types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L114) |
33
+ | <a id="property-spec"></a> `spec` | [`PlaySpec`](PlaySpec.md) | The current PlaySpec to render. | [packages/play-view/src/view-types.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L110) |
34
+ | <a id="property-store"></a> `store` | `StateStore` | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [packages/play-view/src/view-types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/view-types.ts#L118) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: FailureLatch
4
4
 
5
- Defined in: [packages/play-view/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L174)
5
+ Defined in: [packages/play-view/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L174)
6
6
 
7
7
  The record of what a provider reported. See [createFailureLatch](../functions/createFailureLatch.md).
8
8
 
@@ -14,7 +14,7 @@ The record of what a provider reported. See [createFailureLatch](../functions/cr
14
14
  clear(): void;
15
15
  ```
16
16
 
17
- Defined in: [packages/play-view/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L191)
17
+ Defined in: [packages/play-view/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L191)
18
18
 
19
19
  Forgets the record, so the next failure reports again.
20
20
 
@@ -40,7 +40,7 @@ shouldReport(
40
40
  ): boolean;
41
41
  ```
42
42
 
43
- Defined in: [packages/play-view/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-view/src/failure-latch.ts#L181)
43
+ Defined in: [packages/play-view/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-view/src/failure-latch.ts#L181)
44
44
 
45
45
  Answers whether a failure of these three inputs is new, and records it.
46
46