@xmachines/docs 6.1.0 → 8.0.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (604) hide show
  1. package/README.md +5 -5
  2. package/api/@xmachines/core/README.md +7 -2
  3. package/api/@xmachines/core/cache/functions/createLruCache.md +1 -1
  4. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +3 -3
  5. package/api/@xmachines/core/errors/classes/BaseError.md +11 -11
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +11 -11
  7. package/api/@xmachines/core/utils/functions/asDisposable.md +2 -2
  8. package/api/@xmachines/core/utils/functions/createNullRecord.md +1 -1
  9. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  10. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  12. package/api/@xmachines/core/utils/functions/isThenable.md +1 -1
  13. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  14. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  15. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  16. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  18. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  19. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  20. package/api/@xmachines/play/README.md +10 -5
  21. package/api/@xmachines/play/errors/classes/NonNullableError.md +11 -11
  22. package/api/@xmachines/play/errors/classes/PlayError.md +12 -11
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +4 -4
  25. package/api/@xmachines/play-actor/README.md +11 -3
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +4 -4
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +6 -6
  28. package/api/@xmachines/play-atom/README.md +21 -7
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +6 -6
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +4 -4
  34. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  35. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +4 -4
  36. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +3 -3
  37. package/api/@xmachines/play-atom/interfaces/Readable.md +4 -4
  38. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +4 -4
  39. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  40. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +1 -1
  41. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +1 -1
  42. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  43. package/api/@xmachines/play-atom/variables/createWritableAtom.md +1 -1
  44. package/api/@xmachines/play-dom/README.md +136 -50
  45. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -12
  46. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  47. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  48. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -2
  49. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -9
  50. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +15 -14
  51. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +26 -20
  52. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  53. package/api/@xmachines/play-dom/interfaces/PassOptions.md +14 -0
  54. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +18 -17
  55. package/api/@xmachines/play-dom/interfaces/RenderErrorInfo.md +16 -0
  56. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +17 -15
  57. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +9 -8
  58. package/api/@xmachines/play-dom/interfaces/ValidationRegistry.md +14 -11
  59. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +9 -10
  60. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +4 -3
  61. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  62. package/api/@xmachines/play-dom/type-aliases/OnRenderError.md +27 -0
  63. package/api/@xmachines/play-dom/type-aliases/RenderErrorKind.md +21 -0
  64. package/api/@xmachines/play-dom-router/README.md +44 -6
  65. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  66. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  67. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  68. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  69. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  70. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +5 -5
  71. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  72. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  73. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  74. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +9 -9
  75. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  76. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  77. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  78. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  79. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  80. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +8 -8
  81. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  82. package/api/@xmachines/play-pattern/README.md +1 -1
  83. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  84. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  85. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  86. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  87. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  88. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  89. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  90. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  91. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  92. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  93. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  94. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  95. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  96. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  97. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  98. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  99. package/api/@xmachines/play-react/README.md +58 -19
  100. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  101. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  102. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  103. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  104. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  105. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +5 -5
  106. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +11 -11
  107. package/api/@xmachines/play-react/interfaces/DefineRegistryResult.md +15 -0
  108. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +8 -8
  109. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
  110. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +13 -13
  111. package/api/@xmachines/play-react/interfaces/RenderErrorInfo.md +16 -0
  112. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  113. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  114. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  115. package/api/@xmachines/play-react/type-aliases/OnRenderError.md +27 -0
  116. package/api/@xmachines/play-react/type-aliases/RenderErrorKind.md +21 -0
  117. package/api/@xmachines/play-react/variables/ActorProvider.md +14 -4
  118. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  119. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  120. package/api/@xmachines/play-react-router/README.md +26 -5
  121. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  122. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  123. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  124. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  125. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +9 -9
  126. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  127. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +6 -6
  128. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  129. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  130. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  131. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  132. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  133. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  134. package/api/@xmachines/play-router/README.md +87 -29
  135. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +11 -11
  136. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +12 -12
  137. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +12 -12
  138. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +12 -12
  139. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +12 -12
  140. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +12 -12
  141. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +13 -13
  142. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +11 -11
  143. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +13 -13
  144. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  145. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  146. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  154. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  155. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  156. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  158. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  159. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  160. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  161. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +5 -5
  162. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  163. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  164. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  165. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  166. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  167. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  168. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  169. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  170. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  171. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  172. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +5 -5
  173. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +6 -6
  174. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  175. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  176. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  177. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +5 -5
  178. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +8 -8
  179. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +10 -10
  180. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  181. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +14 -14
  182. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +9 -9
  183. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +11 -11
  184. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +5 -5
  185. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +5 -5
  186. package/api/@xmachines/play-router/index/interfaces/Routable.md +5 -5
  187. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +6 -6
  188. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +10 -10
  189. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  190. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +5 -5
  191. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +5 -5
  192. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +12 -12
  193. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +7 -7
  194. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +7 -7
  195. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  196. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  197. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +8 -8
  198. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +8 -8
  199. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +7 -7
  200. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  201. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  202. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  203. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  204. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  205. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  206. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  207. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  208. package/api/@xmachines/play-router/xstate/README.md +5 -2
  209. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +2 -2
  210. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +5 -5
  211. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  212. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  213. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  214. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +7 -8
  215. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +8 -9
  216. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  217. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  218. package/api/@xmachines/play-router/xstate/interfaces/Graph.md +26 -0
  219. package/api/@xmachines/play-router/xstate/interfaces/GraphEdge.md +22 -0
  220. package/api/@xmachines/play-router/xstate/interfaces/GraphNode.md +21 -0
  221. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +6 -6
  222. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +7 -7
  223. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +4 -6
  224. package/api/@xmachines/play-solid/README.md +35 -11
  225. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  226. package/api/@xmachines/play-solid/functions/useBoundProp.md +8 -5
  227. package/api/@xmachines/play-solid/functions/useFieldValidation.md +6 -4
  228. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  229. package/api/@xmachines/play-solid/functions/useStateBinding.md +5 -3
  230. package/api/@xmachines/play-solid/functions/useStateValue.md +5 -3
  231. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  232. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +13 -13
  233. package/api/@xmachines/play-solid/interfaces/RenderErrorInfo.md +16 -0
  234. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  235. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  236. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  237. package/api/@xmachines/play-solid/type-aliases/OnRenderError.md +27 -0
  238. package/api/@xmachines/play-solid/type-aliases/RenderErrorKind.md +21 -0
  239. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  240. package/api/@xmachines/play-solid/variables/ActorProvider.md +17 -3
  241. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  242. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  243. package/api/@xmachines/play-solid-router/README.md +24 -10
  244. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  245. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  246. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  247. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +6 -6
  248. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  249. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  250. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +6 -6
  251. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  252. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  253. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  254. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  255. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  256. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  257. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  258. package/api/@xmachines/play-svelte/README.md +19 -11
  259. package/api/@xmachines/play-svelte/functions/defineRegistry.md +3 -4
  260. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  261. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  262. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  263. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -12
  264. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +8 -8
  265. package/api/@xmachines/play-svelte/interfaces/DefineRegistryResult.md +15 -0
  266. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +14 -14
  267. package/api/@xmachines/play-svelte/interfaces/RenderErrorInfo.md +16 -0
  268. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  269. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  270. package/api/@xmachines/play-svelte/type-aliases/OnRenderError.md +27 -0
  271. package/api/@xmachines/play-svelte/type-aliases/RenderErrorKind.md +21 -0
  272. package/api/@xmachines/play-svelte-spa-router/README.md +14 -7
  273. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  274. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  275. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  276. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +5 -5
  277. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  278. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +9 -9
  279. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +6 -6
  280. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  281. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  282. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  283. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +8 -8
  284. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  285. package/api/@xmachines/play-sveltekit-router/README.md +67 -14
  286. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  287. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +29 -19
  288. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  289. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +5 -5
  290. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +13 -16
  291. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  292. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +9 -9
  293. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +6 -6
  294. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  295. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  296. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  297. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +8 -8
  298. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +25 -0
  299. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +21 -0
  300. package/api/@xmachines/play-tanstack-react-router/README.md +36 -17
  301. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  302. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  303. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  304. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  305. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +9 -9
  306. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +11 -11
  307. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +6 -6
  308. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  309. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  310. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  311. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  312. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  313. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  314. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  315. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  316. package/api/@xmachines/play-tanstack-router/README.md +7 -4
  317. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  318. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  319. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  320. package/api/@xmachines/play-tanstack-solid-router/README.md +50 -17
  321. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  322. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  323. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  324. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +9 -9
  325. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +11 -11
  326. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +6 -6
  327. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  328. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  329. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  330. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  331. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  332. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  333. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  334. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  335. package/api/@xmachines/play-url/README.md +1 -1
  336. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +12 -12
  337. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +12 -12
  338. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +13 -13
  339. package/api/@xmachines/play-url/index/functions/buildPath.md +1 -1
  340. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  341. package/api/@xmachines/play-url/index/functions/createLruCache.md +1 -1
  342. package/api/@xmachines/play-url/index/functions/getCandidates.md +1 -1
  343. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +1 -1
  344. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  345. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  346. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  347. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  348. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  349. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  350. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +1 -1
  351. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  352. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  353. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  354. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  355. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  356. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +5 -5
  357. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  358. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  359. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +6 -6
  360. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  361. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +5 -5
  362. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +9 -9
  363. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  364. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +14 -14
  365. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +6 -6
  366. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +5 -5
  367. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +7 -7
  368. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  369. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  370. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  371. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  372. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +1 -1
  373. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  374. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  375. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  376. package/api/@xmachines/play-view/README.md +45 -19
  377. package/api/@xmachines/play-view/errors/README.md +1 -0
  378. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +13 -13
  379. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +12 -12
  380. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +181 -0
  381. package/api/@xmachines/play-view/index/README.md +10 -4
  382. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +10 -9
  383. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +34 -0
  384. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  385. package/api/@xmachines/play-view/index/functions/composeViews.md +8 -2
  386. package/api/@xmachines/play-view/index/functions/createActorProxy.md +39 -0
  387. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +35 -0
  388. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  389. package/api/@xmachines/play-view/index/functions/createViewSession.md +29 -0
  390. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  391. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +45 -0
  392. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  393. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  394. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  395. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  396. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  397. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +8 -8
  398. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +7 -7
  399. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +7 -7
  400. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +19 -0
  401. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +8 -8
  402. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  403. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  404. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +4 -4
  405. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +7 -7
  406. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +5 -5
  407. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +155 -0
  408. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +12 -0
  409. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +23 -0
  410. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +22 -3
  411. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -6
  412. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +6 -6
  413. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +5 -5
  414. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  415. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +21 -0
  416. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  417. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  418. package/api/@xmachines/play-vue/README.md +20 -15
  419. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  420. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  421. package/api/@xmachines/play-vue/functions/useBoundProp.md +10 -4
  422. package/api/@xmachines/play-vue/functions/useFieldValidation.md +12 -5
  423. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  424. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  425. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  426. package/api/@xmachines/play-vue/interfaces/RenderErrorInfo.md +16 -0
  427. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  428. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  429. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  430. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  431. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  432. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +4 -4
  433. package/api/@xmachines/play-vue/type-aliases/OnRenderError.md +27 -0
  434. package/api/@xmachines/play-vue/type-aliases/RenderErrorKind.md +21 -0
  435. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  436. package/api/@xmachines/play-vue/variables/Renderer.md +3 -3
  437. package/api/@xmachines/play-vue-router/README.md +18 -11
  438. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +11 -11
  439. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +11 -11
  440. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  441. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  442. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +9 -9
  443. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +6 -6
  444. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  445. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +5 -5
  446. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  447. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  448. package/api/@xmachines/play-xstate/README.md +120 -57
  449. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +11 -11
  450. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +12 -12
  451. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +11 -11
  452. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +12 -12
  453. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +12 -12
  454. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  455. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +13 -13
  456. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +15 -15
  457. package/api/@xmachines/play-xstate/index/README.md +1 -1
  458. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +201 -124
  459. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  460. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +14 -10
  461. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +6 -6
  462. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +4 -4
  463. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +9 -9
  464. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  465. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  466. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  467. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  468. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +13 -5
  469. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +26 -13
  470. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  471. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  472. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +8 -8
  473. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +7 -7
  474. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  475. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  476. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  477. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  478. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  479. package/api/@xmachines/play-xstate/with-view/functions/withView.md +1 -1
  480. package/api/@xmachines/shared/README.md +1 -0
  481. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  482. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  483. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  484. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  485. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  486. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  487. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  488. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +1 -1
  489. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  490. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  491. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  492. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  493. package/contributing/architecture.md +100 -61
  494. package/contributing/configuration.md +44 -62
  495. package/contributing/deployment.md +131 -161
  496. package/contributing/development.md +34 -9
  497. package/contributing/migrating-to-play-atom.md +23 -5
  498. package/contributing/testing.md +64 -33
  499. package/examples/@xmachines/play-dom-demo/README.md +2 -2
  500. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +11 -11
  501. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  502. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  503. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  504. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  505. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  506. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  507. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  508. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  509. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  510. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  511. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  512. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  513. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  514. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  515. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  516. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  517. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  518. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  519. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  520. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +17 -17
  521. package/examples/@xmachines/play-dom-router-demo/README.md +4 -3
  522. package/examples/@xmachines/play-react-demo/README.md +2 -2
  523. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +11 -11
  524. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  525. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  526. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  527. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  528. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  529. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  530. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  531. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  532. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  533. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  534. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  535. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  536. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  537. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  538. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  539. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  540. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  541. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  542. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  543. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +17 -17
  544. package/examples/@xmachines/play-react-router-demo/README.md +4 -3
  545. package/examples/@xmachines/play-solid-demo/README.md +3 -3
  546. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +11 -11
  547. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  548. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  549. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  550. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  551. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  552. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  553. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  554. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  555. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  556. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  557. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  558. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  559. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  560. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  561. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  562. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  563. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  564. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  565. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  566. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  567. package/examples/@xmachines/play-solid-router-demo/README.md +9 -3
  568. package/examples/@xmachines/play-svelte-demo/README.md +1 -1
  569. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +11 -11
  570. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  571. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  572. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +17 -17
  573. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +1 -1
  574. package/examples/@xmachines/play-sveltekit-router-demo/README.md +1 -1
  575. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +3 -2
  576. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +9 -8
  577. package/examples/@xmachines/play-vue-demo/README.md +2 -2
  578. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +11 -11
  579. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  580. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  581. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  582. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  583. package/examples/@xmachines/play-vue-router-demo/README.md +3 -3
  584. package/examples/README.md +1 -1
  585. package/examples/basic-state-machine.md +19 -23
  586. package/examples/form-validation.md +60 -61
  587. package/examples/multi-router-integration.md +268 -147
  588. package/examples/routing-patterns.md +73 -43
  589. package/examples/traffic-light.md +24 -22
  590. package/guides/actor-model.md +38 -21
  591. package/guides/atoms.md +48 -8
  592. package/guides/getting-started.md +106 -62
  593. package/guides/inspector.md +103 -37
  594. package/guides/routing.md +7 -2
  595. package/guides/state-machines.md +106 -68
  596. package/guides/views.md +40 -18
  597. package/package.json +6 -6
  598. package/rfc/git.md +13 -5
  599. package/rfc/play.md +53 -31
  600. package/rfc/run.md +7 -4
  601. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +0 -20
  602. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +0 -25
  603. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +0 -60
  604. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +0 -19
@@ -6,7 +6,7 @@
6
6
  type PlayEvent<TPayload> = object & TPayload;
7
7
  ```
8
8
 
9
- Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play/src/types.ts#L71)
9
+ Defined in: [packages/play/src/types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play/src/types.ts#L71)
10
10
 
11
11
  The generic event type of the Play Architecture
12
12
 
@@ -33,9 +33,9 @@ and of the other state machine libraries.
33
33
 
34
34
  ## Type Declaration
35
35
 
36
- | Name | Type | Defined in |
37
- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
38
- | `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play/src/types.ts#L72) |
36
+ | Name | Type | Defined in |
37
+ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
38
+ | `type` | `string` | [packages/play/src/types.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play/src/types.ts#L72) |
39
39
 
40
40
  ## Type Parameters
41
41
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  The actor contract of the XMachines Play Architecture. It names no state machine library.
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-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-8.0.0--next.1-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
8
8
 
9
9
  ## Installation
10
10
 
@@ -30,7 +30,7 @@ An actor of XMachines holds exactly two things:
30
30
 
31
31
  **It is an interface, and no base class.** A state machine library is the concern of an
32
32
  adapter, and [`@xmachines/play-xstate`](../play-xstate/README.md) is the adapter of XState
33
- v5. This package therefore names `xstate` nowhere.
33
+ v6. This package therefore names `xstate` nowhere.
34
34
 
35
35
  The contract was an abstract CLASS that extended `Actor` of `xstate`, and the class carried
36
36
  no implementation at all: both of its members were abstract. Its whole effect was to force
@@ -80,6 +80,13 @@ const value: string = actor.state.get().value;
80
80
  A plain object satisfies the contract as well. Nothing here asks for a class.
81
81
 
82
82
  ```ts
83
+ import type { PlayActor } from "@xmachines/play-actor";
84
+ import { createAtom } from "@xmachines/play-atom";
85
+
86
+ type Snapshot = { readonly value: string };
87
+ type AuthEvent =
88
+ { readonly type: "auth.login"; readonly username: string } | { readonly type: "auth.logout" };
89
+
83
90
  const actor: PlayActor<Snapshot, AuthEvent> = {
84
91
  state: createAtom<Snapshot>({ value: "guest" }),
85
92
  send: () => {},
@@ -100,6 +107,7 @@ actor class of its own engine, and the contract stays out of the inheritance.
100
107
  ```ts
101
108
  import type { PlayActor } from "@xmachines/play-actor";
102
109
  import type { Routable } from "@xmachines/play-router";
110
+ import { createAtom } from "@xmachines/play-atom";
103
111
  import { Actor, type AnyActorLogic } from "xstate";
104
112
 
105
113
  class MyRoutableActor
@@ -125,7 +133,7 @@ each capability with `compose(PlayerActor, withRouting, withView)`.
125
133
 
126
134
  The contract is minimal, and it names no engine: `state` and `send`. A state machine
127
135
  library is the concern of an adapter, and `@xmachines/play-xstate` is the adapter of
128
- XState v5.
136
+ XState v6.
129
137
 
130
138
  A capability is optional, and each one lives with the package that holds its shared
131
139
  machinery:
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorEvent
4
4
 
5
- Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/src/play-actor.ts#L38)
5
+ Defined in: [play-actor.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L38)
6
6
 
7
7
  The minimal shape of an event that an actor receives.
8
8
 
@@ -13,6 +13,6 @@ a union member holds no index signature, so it satisfies that default never.
13
13
 
14
14
  ## Properties
15
15
 
16
- | Property | Modifier | Type | Defined in |
17
- | --------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/src/play-actor.ts#L39) |
16
+ | Property | Modifier | Type | Defined in |
17
+ | --------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
18
+ | <a id="property-type"></a> `type` | `readonly` | `string` | [play-actor.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L39) |
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayActor\<TSnapshot, TEvent\>
4
4
 
5
- Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/src/play-actor.ts#L75)
5
+ Defined in: [play-actor.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L75)
6
6
 
7
7
  The actor contract of the Play Architecture. It names NO engine.
8
8
 
9
9
  An actor of XMachines holds exactly two things, and this interface names both: the
10
10
  reactive snapshot, and the typed event dispatch. A state machine library is the concern
11
- of an adapter, and `@xmachines/play-xstate` is the adapter of XState v5.
11
+ of an adapter, and `@xmachines/play-xstate` is the adapter of XState v6.
12
12
 
13
13
  Both type parameters carry their real type through, and neither one erases it.
14
14
  `AbstractActor` declares `Atom<unknown>`, so every consumer of a snapshot reads
@@ -43,9 +43,9 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
43
43
 
44
44
  ## Properties
45
45
 
46
- | Property | Modifier | Type | Description | Defined in |
47
- | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
48
- | <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/src/play-actor.ts#L82) |
46
+ | Property | Modifier | Type | Description | Defined in |
47
+ | ----------------------------------- | ---------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
48
+ | <a id="property-state"></a> `state` | `readonly` | [`Atom`](../../play-atom/interfaces/Atom.md)\<`TSnapshot`\> | The reactive snapshot of the current actor state. The infrastructure observes this atom, and it reacts to each state change. It therefore holds no coupling to the internal state machine of the actor. | [play-actor.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L82) |
49
49
 
50
50
  ## Methods
51
51
 
@@ -55,7 +55,7 @@ function mount<TSnapshot, TEvent extends ActorEvent>(
55
55
  send(event): void;
56
56
  ```
57
57
 
58
- Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/src/play-actor.ts#L90)
58
+ Defined in: [play-actor.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-actor/src/play-actor.ts#L90)
59
59
 
60
60
  Sends an event to the actor.
61
61
 
@@ -4,17 +4,17 @@
4
4
 
5
5
  The atom primitives for XMachines. They give the Play Architecture fine-grained reactive state. The primitives propagate state without a glitch and without a subscription of the consumer.
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-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-atom)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-8.0.0--next.1-blue)](https://www.npmjs.com/package/@xmachines/play-atom)
8
8
 
9
9
  ## Installation
10
10
 
11
11
  ```bash
12
- pnpm add @xmachines/play-atom @xstate/store
12
+ pnpm add @xmachines/play-atom @xstate/store@^5.0.0-alpha.8
13
13
  ```
14
14
 
15
15
  **Peer dependency.** Install it with the package:
16
16
 
17
- - `@xstate/store` `^4.2.3` — the atom engine.
17
+ - `@xstate/store` `^5.0.0-alpha.8` — the atom engine.
18
18
 
19
19
  Install ONE copy of `@xstate/store` — see [One instance](#one-instance).
20
20
 
@@ -60,9 +60,14 @@ A computation tracks each atom that it reads. A dynamic branch is safe: the comp
60
60
  The getter takes ONE parameter: the value that the atom holds already. It is `undefined` before the first derivation. Return it to keep the atom still, which stops the propagation at this atom:
61
61
 
62
62
  ```typescript
63
- const view = createAtom((previous) => {
64
- const next = derive(source.get());
65
- return equivalent(previous, next) ? (previous ?? null) : next;
63
+ import { createAtom } from "@xmachines/play-atom";
64
+
65
+ const source = createAtom({ title: "Home", clicks: 0 });
66
+
67
+ const view = createAtom<{ title: string }>((previous) => {
68
+ const next = { title: source.get().title };
69
+ // A click changes no title, so the atom keeps the object that it holds
70
+ return previous?.title === next.title ? previous : next;
66
71
  });
67
72
  ```
68
73
 
@@ -115,6 +120,10 @@ The cleanup function is idempotent. A second call is safe, and it does not throw
115
120
  Every atom carries `subscribe`. The observer runs SYNCHRONOUSLY, inside the `set` of the atom that changed, and nothing coalesces the calls. An observer that throws therefore throws inside that `set`, and the failure lands in the code that wrote the atom. Prefer `watchAtom` unless you need the notification at the exact moment of the write.
116
121
 
117
122
  ```typescript
123
+ import { createAtom } from "@xmachines/play-atom";
124
+
125
+ const count = createAtom(0);
126
+
118
127
  const subscription = count.subscribe((value) => console.log(value));
119
128
  subscription.unsubscribe();
120
129
  ```
@@ -123,6 +132,9 @@ The subscription is the plain `{ unsubscribe }` of the engine. To hold it with `
123
132
 
124
133
  ```typescript
125
134
  import { asDisposable } from "@xmachines/core/utils";
135
+ import { createAtom } from "@xmachines/play-atom";
136
+
137
+ const count = createAtom(0);
126
138
 
127
139
  {
128
140
  const plain = count.subscribe((value) => console.log(value));
@@ -192,7 +204,9 @@ See [Migrating to @xmachines/play-atom](../../../contributing/migrating-to-play-
192
204
 
193
205
  - **Node.js** `>= 24.0.0`
194
206
  - **TypeScript** `5.7+` (for a consumer that uses TypeScript)
195
- - **`@xstate/store`** `^4.2.3` — the atom engine, and a PEER dependency
207
+ - **`@xstate/store`** `^5.0.0-alpha.8` — the atom engine, and a PEER dependency
208
+
209
+ XMachines 8.0.0 moves the engine from `@xstate/store` 4 to 5, the line of the store for XState 6. The atom API does not change, so a consumer changes the range of the peer alone. `@xstate/store` 5 is a prerelease, so name its range when you install it: `pnpm add @xstate/store@^5.0.0-alpha.8`. A bare `pnpm add @xstate/store` installs version 4, which does not satisfy the peer.
196
210
 
197
211
  XMachines 5.0.0 moved the engine from `@xstate/store` 3 to 4. A computed getter took a `read` helper in its first position there, and it takes the previous value alone now. Delete that first parameter:
198
212
 
@@ -6,7 +6,7 @@
6
6
  function watchAtom<T>(atom, onValue): () => void;
7
7
  ```
8
8
 
9
- Defined in: [watch-atom.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/watch-atom.ts#L57)
9
+ Defined in: [watch-atom.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/watch-atom.ts#L57)
10
10
 
11
11
  Subscribes to one atom, and coalesces the notifications into one microtask.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: AsyncAtomOptions
4
4
 
5
- Defined in: [types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L168)
5
+ Defined in: [types.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L168)
6
6
 
7
7
  What `createAsyncAtom` gives its getter
8
8
 
@@ -11,6 +11,6 @@ stale answer reaches the atom never. Pass it to `fetch`, and the request stops w
11
11
 
12
12
  ## Properties
13
13
 
14
- | Property | Modifier | Type | Description | Defined in |
15
- | ------------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L170) |
14
+ | Property | Modifier | Type | Description | Defined in |
15
+ | ------------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
16
+ | <a id="property-signal"></a> `signal` | `readonly` | `AbortSignal` | Aborted when the atom derives again before this run settles. | [types.ts:170](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L170) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Atom\<T\>
4
4
 
5
- Defined in: [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L117)
5
+ Defined in: [types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L117)
6
6
 
7
7
  The writable atom. It holds one reactive value
8
8
 
@@ -40,7 +40,7 @@ name.set((previous) => previous.toUpperCase()); // "BOB"
40
40
  get(): T;
41
41
  ```
42
42
 
43
- Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L59)
43
+ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L59)
44
44
 
45
45
  #### Returns
46
46
 
@@ -60,7 +60,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1
60
60
  set(fn): void;
61
61
  ```
62
62
 
63
- Defined in: [types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L119)
63
+ Defined in: [types.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L119)
64
64
 
65
65
  Sets the value of the atom from the previous value.
66
66
 
@@ -80,7 +80,7 @@ Sets the value of the atom from the previous value.
80
80
  set(value): void;
81
81
  ```
82
82
 
83
- Defined in: [types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L121)
83
+ Defined in: [types.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L121)
84
84
 
85
85
  Sets the value of the atom.
86
86
 
@@ -104,7 +104,7 @@ Sets the value of the atom.
104
104
  subscribe(observer): AtomSubscription;
105
105
  ```
106
106
 
107
- Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L60)
107
+ Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L60)
108
108
 
109
109
  ##### Parameters
110
110
 
@@ -130,7 +130,7 @@ subscribe(
130
130
  ): AtomSubscription;
131
131
  ```
132
132
 
133
- Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L61)
133
+ Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L61)
134
134
 
135
135
  ##### Parameters
136
136
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: AtomObserver\<T\>
4
4
 
5
- Defined in: [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L34)
5
+ Defined in: [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L34)
6
6
 
7
7
  The observer of an atom, in the object form
8
8
 
@@ -18,8 +18,8 @@ consumers that adapt an atom to an observable.
18
18
 
19
19
  ## Properties
20
20
 
21
- | Property | Type | Defined in |
22
- | ------------------------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------- |
23
- | <a id="property-complete"></a> `complete?` | () => `void` | [types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L37) |
24
- | <a id="property-error"></a> `error?` | (`error`) => `void` | [types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L36) |
25
- | <a id="property-next"></a> `next?` | (`value`) => `void` | [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L35) |
21
+ | Property | Type | Defined in |
22
+ | ------------------------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------- |
23
+ | <a id="property-complete"></a> `complete?` | () => `void` | [types.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L37) |
24
+ | <a id="property-error"></a> `error?` | (`error`) => `void` | [types.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L36) |
25
+ | <a id="property-next"></a> `next?` | (`value`) => `void` | [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L35) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: AtomOptions\<T\>
4
4
 
5
- Defined in: [types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L147)
5
+ Defined in: [types.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L147)
6
6
 
7
7
  The options of `createAtom`
8
8
 
@@ -28,6 +28,6 @@ const point = createAtom(
28
28
 
29
29
  ## Properties
30
30
 
31
- | Property | Type | Defined in |
32
- | ---------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
33
- | <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L148) |
31
+ | Property | Type | Defined in |
32
+ | ---------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
33
+ | <a id="property-compare"></a> `compare?` | (`previous`, `next`) => `boolean` | [types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L148) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: AtomSubscription
4
4
 
5
- Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L23)
5
+ Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L23)
6
6
 
7
7
  The release of one subscription
8
8
 
@@ -16,7 +16,7 @@ The release of one subscription
16
16
  unsubscribe(): void;
17
17
  ```
18
18
 
19
- Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L24)
19
+ Defined in: [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L24)
20
20
 
21
21
  #### Returns
22
22
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseAtom\<T\>
4
4
 
5
- Defined in: [types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L74)
5
+ Defined in: [types.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L74)
6
6
 
7
7
  The common base of a writable atom and a computed atom
8
8
 
@@ -32,7 +32,7 @@ both kinds.
32
32
  get(): T;
33
33
  ```
34
34
 
35
- Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L59)
35
+ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L59)
36
36
 
37
37
  #### Returns
38
38
 
@@ -52,7 +52,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1
52
52
  subscribe(observer): AtomSubscription;
53
53
  ```
54
54
 
55
- Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L60)
55
+ Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L60)
56
56
 
57
57
  ##### Parameters
58
58
 
@@ -78,7 +78,7 @@ subscribe(
78
78
  ): AtomSubscription;
79
79
  ```
80
80
 
81
- Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L61)
81
+ Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L61)
82
82
 
83
83
  ##### Parameters
84
84
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: CreateAtom()
4
4
 
5
- Defined in: [create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-atom.ts#L33)
5
+ Defined in: [create-atom.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-atom.ts#L33)
6
6
 
7
7
  The two forms of `createAtom`
8
8
 
@@ -22,7 +22,7 @@ because `get` tracked the edge already.
22
22
  CreateAtom<T>(getValue, options?): ReadonlyAtom<T>;
23
23
  ```
24
24
 
25
- Defined in: [create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-atom.ts#L34)
25
+ Defined in: [create-atom.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-atom.ts#L34)
26
26
 
27
27
  The two forms of `createAtom`
28
28
 
@@ -59,7 +59,7 @@ because `get` tracked the edge already.
59
59
  CreateAtom<T>(initialValue, options?): Atom<T>;
60
60
  ```
61
61
 
62
- Defined in: [create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-atom.ts#L35)
62
+ Defined in: [create-atom.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-atom.ts#L35)
63
63
 
64
64
  The two forms of `createAtom`
65
65
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Readable\<T\>
4
4
 
5
- Defined in: [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L58)
5
+ Defined in: [types.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L58)
6
6
 
7
7
  The read side of an atom
8
8
 
@@ -40,7 +40,7 @@ show(createAtom("ready")); // "ready"
40
40
  get(): T;
41
41
  ```
42
42
 
43
- Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L59)
43
+ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L59)
44
44
 
45
45
  #### Returns
46
46
 
@@ -56,7 +56,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1
56
56
  subscribe(observer): AtomSubscription;
57
57
  ```
58
58
 
59
- Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L60)
59
+ Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L60)
60
60
 
61
61
  ##### Parameters
62
62
 
@@ -78,7 +78,7 @@ subscribe(
78
78
  ): AtomSubscription;
79
79
  ```
80
80
 
81
- Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L61)
81
+ Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L61)
82
82
 
83
83
  ##### Parameters
84
84
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ReadonlyAtom\<T\>
4
4
 
5
- Defined in: [types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L97)
5
+ Defined in: [types.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L97)
6
6
 
7
7
  The computed atom. It evaluates late, and it memoizes the result
8
8
 
@@ -43,7 +43,7 @@ console.log(doubled.get()); // 10 (from the memory, with no new computation)
43
43
  get(): T;
44
44
  ```
45
45
 
46
- Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L59)
46
+ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L59)
47
47
 
48
48
  #### Returns
49
49
 
@@ -63,7 +63,7 @@ Defined in: [types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1
63
63
  subscribe(observer): AtomSubscription;
64
64
  ```
65
65
 
66
- Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L60)
66
+ Defined in: [types.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L60)
67
67
 
68
68
  ##### Parameters
69
69
 
@@ -89,7 +89,7 @@ subscribe(
89
89
  ): AtomSubscription;
90
90
  ```
91
91
 
92
- Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L61)
92
+ Defined in: [types.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L61)
93
93
 
94
94
  ##### Parameters
95
95
 
@@ -6,7 +6,7 @@
6
6
  type AnyAtom = BaseAtom<unknown>;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L129)
9
+ Defined in: [types.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L129)
10
10
 
11
11
  An atom of an unknown value type
12
12
 
@@ -17,7 +17,7 @@ type AsyncAtomState<TData, TError> =
17
17
  };
18
18
  ```
19
19
 
20
- Defined in: [types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/types.ts#L157)
20
+ Defined in: [types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/types.ts#L157)
21
21
 
22
22
  The state of an atom that reads a promise
23
23
 
@@ -7,7 +7,7 @@ const createAsyncAtom: <T>(getValue, options?) => ReadonlyAtom<AsyncAtomState<T>
7
7
  createEngineAsyncAtom;
8
8
  ```
9
9
 
10
- Defined in: [create-atom.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-atom.ts#L64)
10
+ Defined in: [create-atom.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-atom.ts#L64)
11
11
 
12
12
  Builds a read-only atom that holds the state of a promise
13
13
 
@@ -6,7 +6,7 @@
6
6
  const createAtom: CreateAtom = createEngineAtom;
7
7
  ```
8
8
 
9
- Defined in: [create-atom.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-atom.ts#L47)
9
+ Defined in: [create-atom.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-atom.ts#L47)
10
10
 
11
11
  Builds a writable atom from a value, and a computed atom from a function
12
12
 
@@ -6,7 +6,7 @@
6
6
  const createWritableAtom: <T>(initialValue, options?) => Atom<T> = createAtom;
7
7
  ```
8
8
 
9
- Defined in: [create-writable-atom.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-atom/src/create-writable-atom.ts#L50)
9
+ Defined in: [create-writable-atom.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v8.0.0-next.1/packages/play-atom/src/create-writable-atom.ts#L50)
10
10
 
11
11
  Builds a WRITABLE atom, and never a computed one.
12
12