@xmachines/docs 6.0.0 → 6.1.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 (538) hide show
  1. package/README.md +6 -5
  2. package/api/@xmachines/core/README.md +1 -1
  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 +4 -4
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +4 -4
  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 +1 -1
  21. package/api/@xmachines/play/errors/classes/NonNullableError.md +4 -4
  22. package/api/@xmachines/play/errors/classes/PlayError.md +5 -4
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +1 -1
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +2 -2
  25. package/api/@xmachines/play-actor/README.md +1 -1
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +2 -2
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +3 -3
  28. package/api/@xmachines/play-atom/README.md +2 -2
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +1 -1
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +2 -2
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +6 -6
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +4 -4
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +2 -2
  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 +9 -14
  45. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  46. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  47. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  48. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +11 -11
  49. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +2 -2
  50. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  51. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +14 -14
  52. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  53. package/api/@xmachines/play-dom-router/README.md +1 -1
  54. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  55. package/api/@xmachines/play-dom-router/classes/RouteMap.md +4 -4
  56. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  57. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  58. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  59. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +3 -3
  60. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  61. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  62. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +8 -8
  63. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +7 -7
  64. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  65. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  66. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +4 -4
  67. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  68. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  69. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +6 -6
  70. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  71. package/api/@xmachines/play-pattern/README.md +1 -1
  72. package/api/@xmachines/play-pattern/functions/buildPath.md +1 -1
  73. package/api/@xmachines/play-pattern/functions/createLruCache.md +1 -1
  74. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  75. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  76. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  77. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +4 -4
  78. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +3 -3
  79. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +3 -3
  80. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +7 -7
  81. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +2 -2
  82. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +12 -12
  83. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +4 -4
  84. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  85. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  86. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  87. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  88. package/api/@xmachines/play-react/README.md +2 -2
  89. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
  90. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  91. package/api/@xmachines/play-react/functions/useAtomEffect.md +1 -1
  92. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  93. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  94. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  95. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
  96. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  97. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  98. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  99. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  100. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  101. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  102. package/api/@xmachines/play-react-router/README.md +1 -1
  103. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  104. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  105. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  106. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  107. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  108. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  109. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +4 -4
  110. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +4 -4
  111. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  112. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  113. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  114. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  115. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-router/README.md +7 -8
  117. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +4 -4
  118. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +5 -5
  119. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +5 -5
  120. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +5 -5
  121. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +5 -5
  122. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +5 -5
  123. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +6 -6
  124. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +4 -4
  125. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +6 -6
  126. package/api/@xmachines/play-router/index/classes/RouteMap.md +4 -4
  127. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +7 -7
  128. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  129. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +1 -1
  130. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  131. package/api/@xmachines/play-router/index/functions/createLruCache.md +1 -1
  132. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  133. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  134. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  135. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  136. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  137. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  138. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  139. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  140. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  141. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  142. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  143. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +3 -3
  144. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  145. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +1 -1
  146. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  147. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  148. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  149. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  150. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  151. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  152. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  153. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  154. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +3 -3
  155. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +4 -4
  156. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +3 -3
  157. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +7 -7
  158. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +3 -3
  159. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +3 -3
  160. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +6 -6
  161. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +8 -8
  162. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +2 -2
  163. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +12 -12
  164. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +7 -7
  165. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +9 -9
  166. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +3 -3
  167. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +3 -3
  168. package/api/@xmachines/play-router/index/interfaces/Routable.md +3 -3
  169. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +4 -4
  170. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +8 -8
  171. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +4 -4
  172. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +3 -3
  173. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +3 -3
  174. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +10 -10
  175. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +12 -15
  176. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +5 -5
  177. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  178. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  179. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +5 -5
  180. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +6 -6
  181. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +5 -5
  182. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  183. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  184. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  185. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  186. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  187. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  188. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  189. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  190. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  191. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  192. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  193. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  194. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  195. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  196. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  197. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  198. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  199. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +3 -3
  200. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +5 -5
  201. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  202. package/api/@xmachines/play-solid/README.md +1 -4
  203. package/api/@xmachines/play-solid/functions/defineRegistry.md +5 -5
  204. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  205. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  206. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  207. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +9 -8
  208. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  209. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  210. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  211. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  212. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  213. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  214. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  215. package/api/@xmachines/play-solid/variables/schema.md +35 -54
  216. package/api/@xmachines/play-solid-router/README.md +2 -2
  217. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  218. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +8 -8
  219. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  220. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +3 -3
  221. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  222. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  223. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +4 -4
  224. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +4 -4
  225. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  226. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  227. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  228. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  229. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  230. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  231. package/api/@xmachines/play-svelte/README.md +2 -2
  232. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  233. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  234. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  235. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  236. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  237. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +10 -8
  238. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +10 -8
  239. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  240. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  241. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  242. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  243. package/api/@xmachines/play-svelte-spa-router/README.md +1 -1
  244. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  245. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +7 -7
  246. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +3 -3
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +8 -8
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +4 -4
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +4 -4
  252. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  253. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  254. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +6 -6
  255. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  256. package/api/@xmachines/play-sveltekit-router/README.md +1 -1
  257. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  258. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +7 -7
  259. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  260. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +3 -3
  261. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +8 -8
  262. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  263. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +7 -7
  264. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +4 -4
  265. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +4 -4
  266. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  267. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  268. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +6 -6
  269. package/api/@xmachines/play-tanstack-react-router/README.md +1 -1
  270. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  271. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  272. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  273. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +9 -9
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +4 -4
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +4 -4
  278. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  279. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  281. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  282. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  283. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
  284. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  285. package/api/@xmachines/play-tanstack-router/README.md +1 -1
  286. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  287. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  288. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +5 -5
  289. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  290. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  291. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  292. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +9 -9
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +4 -4
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +4 -4
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  298. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  302. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +5 -5
  303. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  304. package/api/@xmachines/play-url/README.md +1 -1
  305. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +5 -5
  306. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +5 -5
  307. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +6 -6
  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/createLruCache.md +1 -1
  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 +3 -3
  327. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +7 -7
  328. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +4 -4
  329. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +3 -3
  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 +2 -2
  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 +53 -22
  346. package/api/@xmachines/play-view/errors/README.md +1 -0
  347. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +204 -0
  348. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +5 -5
  349. package/api/@xmachines/play-view/index/README.md +6 -0
  350. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +1 -1
  351. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  352. package/api/@xmachines/play-view/index/functions/composeViews.md +35 -0
  353. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +1 -1
  354. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  355. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  356. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  357. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  358. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  359. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +1 -1
  360. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  361. package/api/@xmachines/play-view/index/functions/typedSpec.md +11 -11
  362. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +5 -5
  363. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +5 -5
  364. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +16 -0
  365. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +3 -3
  366. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +12 -8
  367. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  368. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +3 -3
  369. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +2 -2
  370. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +4 -4
  371. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +25 -0
  372. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +23 -0
  373. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +3 -3
  374. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +4 -4
  375. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +15 -0
  376. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +14 -0
  377. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  378. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +1 -1
  379. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  380. package/api/@xmachines/play-vue/README.md +3 -5
  381. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  382. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  383. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  384. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  385. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  386. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  387. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  388. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  389. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  390. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  391. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  392. package/api/@xmachines/play-vue-router/README.md +1 -1
  393. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +4 -4
  394. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +4 -4
  395. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +4 -4
  396. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  397. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +7 -7
  398. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +4 -4
  399. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +4 -4
  400. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +3 -3
  401. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  402. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +1 -1
  403. package/api/@xmachines/play-xstate/README.md +24 -17
  404. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +4 -4
  405. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +5 -5
  406. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +4 -4
  407. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +5 -5
  408. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +5 -5
  409. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +7 -7
  410. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +6 -6
  411. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +6 -6
  412. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +10 -10
  413. package/api/@xmachines/play-xstate/index/functions/compose.md +4 -4
  414. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +2 -2
  415. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +4 -4
  416. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +2 -2
  417. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +7 -7
  418. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +1 -1
  419. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +1 -1
  420. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +1 -1
  421. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +1 -1
  422. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  423. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +1 -1
  424. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  425. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +1 -1
  426. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +5 -5
  427. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +12 -15
  428. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  429. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  430. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +4 -4
  431. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  432. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +5 -5
  433. package/api/@xmachines/play-xstate/with-view/functions/withView.md +2 -4
  434. package/api/@xmachines/shared/vite-aliases/README.md +7 -0
  435. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +11 -5
  436. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +37 -0
  437. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +28 -0
  438. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  439. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  440. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  441. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  442. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +26 -0
  443. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +15 -0
  444. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  445. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +5 -1
  446. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  447. package/api/llms.txt +8 -4
  448. package/contributing/architecture.md +18 -8
  449. package/contributing/configuration.md +39 -6
  450. package/contributing/development.md +3 -1
  451. package/contributing/migrating-to-play-atom.md +1 -1
  452. package/contributing/testing.md +33 -4
  453. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +9 -9
  454. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +1 -1
  455. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  456. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  457. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  458. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  459. package/examples/@xmachines/play-dom-demo/variables/Button.md +1 -1
  460. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  461. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  462. package/examples/@xmachines/play-dom-demo/variables/Field.md +1 -1
  463. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  464. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  465. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  466. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  467. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  468. package/examples/@xmachines/play-dom-demo/variables/Panel.md +1 -1
  469. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  470. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  471. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  472. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  473. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +15 -15
  474. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +9 -9
  475. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  476. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  477. package/examples/@xmachines/play-react-demo/variables/Button.md +1 -1
  478. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  479. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  480. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  481. package/examples/@xmachines/play-react-demo/variables/Field.md +1 -1
  482. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  483. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  484. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  485. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  486. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  487. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  488. package/examples/@xmachines/play-react-demo/variables/Panel.md +1 -1
  489. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  490. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  491. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  492. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  493. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  494. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +15 -15
  495. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +9 -9
  496. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  497. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  498. package/examples/@xmachines/play-solid-demo/variables/Button.md +1 -1
  499. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  500. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  501. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  502. package/examples/@xmachines/play-solid-demo/variables/Field.md +1 -1
  503. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  504. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  505. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  506. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  507. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  508. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  509. package/examples/@xmachines/play-solid-demo/variables/Panel.md +1 -1
  510. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  511. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  512. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  513. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  514. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +190 -277
  515. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +17 -17
  516. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +9 -9
  517. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  518. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +190 -277
  519. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +15 -15
  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 +1 -1
  524. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +1 -1
  525. package/examples/README.md +1 -1
  526. package/examples/multi-router-integration.md +1 -1
  527. package/examples/routing-patterns.md +1 -1
  528. package/examples/traffic-light.md +1 -1
  529. package/guides/README.md +5 -4
  530. package/guides/actor-model.md +4 -4
  531. package/guides/atoms.md +4 -4
  532. package/guides/getting-started.md +2 -6
  533. package/guides/inspector.md +1 -1
  534. package/guides/routing.md +41 -45
  535. package/guides/state-machines.md +69 -4
  536. package/guides/views.md +347 -0
  537. package/package.json +1 -1
  538. package/rfc/play.md +24 -8
package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ActorThrewNonErrorError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L309)
5
+ Defined in: [packages/play-xstate/src/errors.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L309)
6
6
 
7
7
  The actor gives this error to `PlayerOptions.onError` when it failed with a value
8
8
  that is not an `Error`, for example after a machine action ran
@@ -46,7 +46,7 @@ definePlayer({
46
46
  new ActorThrewNonErrorError(value): ActorThrewNonErrorError;
47
47
  ```
48
48
 
49
- Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L310)
49
+ Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L310)
50
50
 
51
51
  #### Parameters
52
52
 
@@ -67,10 +67,10 @@ Defined in: [packages/play-xstate/src/errors.ts:310](https://gitlab.com/xmachin-
67
67
  | Property | Modifier | Type | Description | Inherited from | Defined in |
68
68
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
69
69
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
70
- | <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) |
70
+ | <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.1.0/packages/core/src/errors.ts#L56) |
71
71
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
72
72
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
73
- | <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) |
73
+ | <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.1.0/packages/core/src/errors.ts#L46) |
74
74
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
75
75
  | <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) | - |
76
76
 
package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidEventError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L264)
5
+ Defined in: [packages/play-xstate/src/errors.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L264)
6
6
 
7
7
  `PlayerActor.send()` throws this error when the event argument is not a plain
8
8
  object.
@@ -44,7 +44,7 @@ try {
44
44
  new InvalidEventError(detail): InvalidEventError;
45
45
  ```
46
46
 
47
- Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L268)
47
+ Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L268)
48
48
 
49
49
  #### Parameters
50
50
 
@@ -65,11 +65,11 @@ Defined in: [packages/play-xstate/src/errors.ts:268](https://gitlab.com/xmachin-
65
65
  | Property | Modifier | Type | Description | Inherited from | Defined in |
66
66
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
67
67
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
68
- | <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) |
69
- | <a id="property-detail"></a> `detail` | `readonly` | `unknown` | The value in question, from the `send()` call. | - | [packages/play-xstate/src/errors.ts:266](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L266) |
68
+ | <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.1.0/packages/core/src/errors.ts#L56) |
69
+ | <a id="property-detail"></a> `detail` | `readonly` | `unknown` | The value in question, from the `send()` call. | - | [packages/play-xstate/src/errors.ts:266](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L266) |
70
70
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
71
71
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
72
- | <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) |
72
+ | <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.1.0/packages/core/src/errors.ts#L46) |
73
73
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
74
74
  | <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) | - |
75
75
 
package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidMachineError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L161)
5
+ Defined in: [packages/play-xstate/src/errors.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L161)
6
6
 
7
7
  The `PlayerActor` constructor throws this error when the `machine` argument is not
8
8
  a valid XState machine object, which means that it is null, undefined, or not an
@@ -22,7 +22,7 @@ object.
22
22
  new InvalidMachineError(): InvalidMachineError;
23
23
  ```
24
24
 
25
- Defined in: [packages/play-xstate/src/errors.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L162)
25
+ Defined in: [packages/play-xstate/src/errors.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L162)
26
26
 
27
27
  #### Returns
28
28
 
@@ -37,10 +37,10 @@ Defined in: [packages/play-xstate/src/errors.ts:162](https://gitlab.com/xmachin-
37
37
  | Property | Modifier | Type | Description | Inherited from | Defined in |
38
38
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
39
39
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
40
- | <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) |
40
+ | <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.1.0/packages/core/src/errors.ts#L56) |
41
41
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
42
42
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
43
- | <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) |
43
+ | <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.1.0/packages/core/src/errors.ts#L46) |
44
44
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
45
45
  | <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) | - |
46
46
 
package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidRouteHandlerError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L220)
5
+ Defined in: [packages/play-xstate/src/errors.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L220)
6
6
 
7
7
  `formatPlayRouteTransitions()` throws this error for a `meta.route` object whose
8
8
  `handler` field holds a value that the routing layer does not know.
@@ -42,7 +42,7 @@ try {
42
42
  new InvalidRouteHandlerError(handler, source?): InvalidRouteHandlerError;
43
43
  ```
44
44
 
45
- Defined in: [packages/play-xstate/src/errors.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L224)
45
+ Defined in: [packages/play-xstate/src/errors.ts:224](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L224)
46
46
 
47
47
  #### Parameters
48
48
 
@@ -64,11 +64,11 @@ Defined in: [packages/play-xstate/src/errors.ts:224](https://gitlab.com/xmachin-
64
64
  | Property | Modifier | Type | Description | Inherited from | Defined in |
65
65
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
66
66
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
67
- | <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) |
68
- | <a id="property-handler"></a> `handler` | `readonly` | `string` | The value that the config declared, as a string, for the debug work. | - | [packages/play-xstate/src/errors.ts:222](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L222) |
67
+ | <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.1.0/packages/core/src/errors.ts#L56) |
68
+ | <a id="property-handler"></a> `handler` | `readonly` | `string` | The value that the config declared, as a string, for the debug work. | - | [packages/play-xstate/src/errors.ts:222](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L222) |
69
69
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
70
70
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
71
- | <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) |
71
+ | <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.1.0/packages/core/src/errors.ts#L46) |
72
72
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
73
73
  | <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) | - |
74
74
 
package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidRouteMetadataError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L178)
5
+ Defined in: [packages/play-xstate/src/errors.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L178)
6
6
 
7
7
  `normalizeRoute()` throws this error when the `meta.route` value of a state is not
8
8
  a string and not an object with a `path` property.
@@ -21,7 +21,7 @@ a string and not an object with a `path` property.
21
21
  new InvalidRouteMetadataError(route, source?): InvalidRouteMetadataError;
22
22
  ```
23
23
 
24
- Defined in: [packages/play-xstate/src/errors.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L182)
24
+ Defined in: [packages/play-xstate/src/errors.ts:182](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L182)
25
25
 
26
26
  #### Parameters
27
27
 
@@ -43,11 +43,11 @@ Defined in: [packages/play-xstate/src/errors.ts:182](https://gitlab.com/xmachin-
43
43
  | Property | Modifier | Type | Description | Inherited from | Defined in |
44
44
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
45
45
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
46
- | <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) |
47
- | <a id="property-detail"></a> `detail` | `readonly` | `string` | The invalid route value, as a string, for the debug work. | - | [packages/play-xstate/src/errors.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L180) |
46
+ | <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.1.0/packages/core/src/errors.ts#L56) |
47
+ | <a id="property-detail"></a> `detail` | `readonly` | `string` | The invalid route value, as a string, for the debug work. | - | [packages/play-xstate/src/errors.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L180) |
48
48
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
49
49
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
50
- | <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) |
50
+ | <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.1.0/packages/core/src/errors.ts#L46) |
51
51
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
52
52
  | <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) | - |
53
53
 
package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidRouteParamError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L81)
5
+ Defined in: [packages/play-xstate/src/errors.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L81)
6
6
 
7
7
  `buildRouteUrl()` throws this error when a route parameter carries a value that no path
8
8
  can hold, so the template matches the built URL back never.
@@ -49,7 +49,7 @@ new InvalidRouteParamError(
49
49
  ): InvalidRouteParamError;
50
50
  ```
51
51
 
52
- Defined in: [packages/play-xstate/src/errors.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L91)
52
+ Defined in: [packages/play-xstate/src/errors.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L91)
53
53
 
54
54
  #### Parameters
55
55
 
@@ -72,14 +72,14 @@ Defined in: [packages/play-xstate/src/errors.ts:91](https://gitlab.com/xmachin-e
72
72
  | Property | Modifier | Type | Description | Inherited from | Defined in |
73
73
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
74
74
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
75
- | <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) |
75
+ | <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.1.0/packages/core/src/errors.ts#L56) |
76
76
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
77
77
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
78
- | <a id="property-param"></a> `param` | `readonly` | `string` | The name of the route parameter that carries the value, for example `"name"`. | - | [packages/play-xstate/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L83) |
79
- | <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) |
78
+ | <a id="property-param"></a> `param` | `readonly` | `string` | The name of the route parameter that carries the value, for example `"name"`. | - | [packages/play-xstate/src/errors.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L83) |
79
+ | <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.1.0/packages/core/src/errors.ts#L46) |
80
80
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
81
- | <a id="property-template"></a> `template` | `readonly` | `string` | The route template that declares the parameter, for example `"/files/:name"`. | - | [packages/play-xstate/src/errors.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L89) |
82
- | <a id="property-value"></a> `value` | `readonly` | `string` | The value that no path can hold, for example `".."`. | - | [packages/play-xstate/src/errors.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L86) |
81
+ | <a id="property-template"></a> `template` | `readonly` | `string` | The route template that declares the parameter, for example `"/files/:name"`. | - | [packages/play-xstate/src/errors.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L89) |
82
+ | <a id="property-value"></a> `value` | `readonly` | `string` | The value that no path can hold, for example `".."`. | - | [packages/play-xstate/src/errors.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L86) |
83
83
  | <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) | - |
84
84
 
85
85
  ## Methods
package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: MissingRouteParamError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L33)
5
+ Defined in: [packages/play-xstate/src/errors.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L33)
6
6
 
7
7
  `buildRouteUrl()` throws this error when the context of the actor does not hold a
8
8
  necessary route parameter.
@@ -43,7 +43,7 @@ try {
43
43
  new MissingRouteParamError(param, template): MissingRouteParamError;
44
44
  ```
45
45
 
46
- Defined in: [packages/play-xstate/src/errors.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L40)
46
+ Defined in: [packages/play-xstate/src/errors.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L40)
47
47
 
48
48
  #### Parameters
49
49
 
@@ -65,13 +65,13 @@ Defined in: [packages/play-xstate/src/errors.ts:40](https://gitlab.com/xmachin-e
65
65
  | Property | Modifier | Type | Description | Inherited from | Defined in |
66
66
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
67
67
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
68
- | <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) |
68
+ | <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.1.0/packages/core/src/errors.ts#L56) |
69
69
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
70
70
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
71
- | <a id="property-param"></a> `param` | `readonly` | `string` | The name of the route parameter that was absent, for example `"userId"`. | - | [packages/play-xstate/src/errors.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L35) |
72
- | <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) |
71
+ | <a id="property-param"></a> `param` | `readonly` | `string` | The name of the route parameter that was absent, for example `"userId"`. | - | [packages/play-xstate/src/errors.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L35) |
72
+ | <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.1.0/packages/core/src/errors.ts#L46) |
73
73
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
74
- | <a id="property-template"></a> `template` | `readonly` | `string` | The route template that needs the absent parameter, for example `"/profile/:userId"`. | - | [packages/play-xstate/src/errors.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L38) |
74
+ | <a id="property-template"></a> `template` | `readonly` | `string` | The route template that needs the absent parameter, for example `"/profile/:userId"`. | - | [packages/play-xstate/src/errors.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L38) |
75
75
  | <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) | - |
76
76
 
77
77
  ## Methods
package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: MissingStateIdError
4
4
 
5
- Defined in: [packages/play-xstate/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L135)
5
+ Defined in: [packages/play-xstate/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L135)
6
6
 
7
7
  `formatPlayRouteTransitions()` throws this error when a state node declares a
8
8
  `meta.route` field but no explicit `id` field.
@@ -47,7 +47,7 @@ states: {
47
47
  new MissingStateIdError(stateKey, route): MissingStateIdError;
48
48
  ```
49
49
 
50
- Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L141)
50
+ Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L141)
51
51
 
52
52
  #### Parameters
53
53
 
@@ -69,13 +69,13 @@ Defined in: [packages/play-xstate/src/errors.ts:141](https://gitlab.com/xmachin-
69
69
  | Property | Modifier | Type | Description | Inherited from | Defined in |
70
70
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
71
71
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
72
- | <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) |
72
+ | <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.1.0/packages/core/src/errors.ts#L56) |
73
73
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
74
74
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
75
- | <a id="property-route"></a> `route` | `readonly` | `string` | The route template of the state, for example `"/profile/:username"`. | - | [packages/play-xstate/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L139) |
76
- | <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) |
75
+ | <a id="property-route"></a> `route` | `readonly` | `string` | The route template of the state, for example `"/profile/:username"`. | - | [packages/play-xstate/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L139) |
76
+ | <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.1.0/packages/core/src/errors.ts#L46) |
77
77
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
78
- | <a id="property-statekey"></a> `stateKey` | `readonly` | `string` | The state key, which is the position in the tree of the states, without an explicit `id` field. | - | [packages/play-xstate/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/errors.ts#L137) |
78
+ | <a id="property-statekey"></a> `stateKey` | `readonly` | `string` | The state key, which is the position in the tree of the states, without an explicit `id` field. | - | [packages/play-xstate/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/errors.ts#L137) |
79
79
  | <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) | - |
80
80
 
81
81
  ## Methods
package/api/@xmachines/play-xstate/index/classes/PlayerActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayerActor\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/player-actor.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L144)
5
+ Defined in: [packages/play-xstate/src/player-actor.ts:144](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L144)
6
6
 
7
7
  The concrete XState actor. It implements the atom protocol of the Play Architecture
8
8
 
@@ -121,7 +121,7 @@ new PlayerActor<TMachine>(
121
121
  ): PlayerActor<TMachine>;
122
122
  ```
123
123
 
124
- Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L242)
124
+ Defined in: [packages/play-xstate/src/player-actor.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L242)
125
125
 
126
126
  #### Parameters
127
127
 
@@ -154,7 +154,7 @@ Actor<TMachine>.constructor
154
154
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TMachine`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TMachine`\>\> | - | `Actor.ref` | - |
155
155
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
156
156
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
157
- | <a id="property-state"></a> `state` | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | 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. | - | [packages/play-xstate/src/player-actor.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L208) |
157
+ | <a id="property-state"></a> `state` | `public` | [`Atom`](../../../play-atom/interfaces/Atom.md)\<`ReturnType`\<`TMachine`\[`"transition"`\]\>\> | 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. | - | [packages/play-xstate/src/player-actor.ts:208](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L208) |
158
158
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
159
159
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
160
160
 
@@ -186,7 +186,7 @@ Actor.[observable]
186
186
  can(event): boolean;
187
187
  ```
188
188
 
189
- Defined in: [packages/play-xstate/src/player-actor.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L221)
189
+ Defined in: [packages/play-xstate/src/player-actor.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L221)
190
190
 
191
191
  Tells you if the current state of the actor accepts the given event.
192
192
 
@@ -217,7 +217,7 @@ if (actor.can({ type: "auth.logout" })) { ... }
217
217
  getPersistedSnapshot(options?): Snapshot<unknown>;
218
218
  ```
219
219
 
220
- Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L555)
220
+ Defined in: [packages/play-xstate/src/player-actor.ts:555](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L555)
221
221
 
222
222
  Returns the persisted snapshot of this actor.
223
223
 
@@ -351,7 +351,7 @@ Actor.select;
351
351
  send(event): void;
352
352
  ```
353
353
 
354
- Defined in: [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L432)
354
+ Defined in: [packages/play-xstate/src/player-actor.ts:432](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L432)
355
355
 
356
356
  Sends an event to this actor.
357
357
 
@@ -403,7 +403,7 @@ Actor.send;
403
403
  start(): this;
404
404
  ```
405
405
 
406
- Defined in: [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L358)
406
+ Defined in: [packages/play-xstate/src/player-actor.ts:358](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L358)
407
407
 
408
408
  Starts the actor.
409
409
 
@@ -431,7 +431,7 @@ Actor.start;
431
431
  stop(): this;
432
432
  ```
433
433
 
434
- Defined in: [packages/play-xstate/src/player-actor.ts:388](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L388)
434
+ Defined in: [packages/play-xstate/src/player-actor.ts:388](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L388)
435
435
 
436
436
  Stops the actor and cleans up.
437
437
 
@@ -462,7 +462,7 @@ Actor.stop;
462
462
  subscribe(observer): Subscription;
463
463
  ```
464
464
 
465
- Defined in: [packages/play-xstate/src/player-actor.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L493)
465
+ Defined in: [packages/play-xstate/src/player-actor.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L493)
466
466
 
467
467
  Subscribes to the snapshot updates of this actor.
468
468
 
@@ -496,7 +496,7 @@ subscribe(
496
496
  ): Subscription;
497
497
  ```
498
498
 
499
- Defined in: [packages/play-xstate/src/player-actor.ts:504](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/player-actor.ts#L504)
499
+ Defined in: [packages/play-xstate/src/player-actor.ts:504](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/player-actor.ts#L504)
500
500
 
501
501
  Subscribes to the snapshot updates of this actor.
502
502
 
package/api/@xmachines/play-xstate/index/functions/compose.md CHANGED
@@ -8,7 +8,7 @@
8
8
  function compose<TMachine>(Base): PlayerConstructor<TMachine>;
9
9
  ```
10
10
 
11
- Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/capabilities.ts#L103)
11
+ Defined in: [packages/play-xstate/src/capabilities.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L103)
12
12
 
13
13
  Builds an actor class from a base and a list of capabilities.
14
14
 
@@ -59,7 +59,7 @@ applies them from left to right.
59
59
  function compose<TMachine, TC1>(Base, c1): PlayerConstructor<TMachine, TC1>;
60
60
  ```
61
61
 
62
- Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/capabilities.ts#L106)
62
+ Defined in: [packages/play-xstate/src/capabilities.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L106)
63
63
 
64
64
  Builds an actor class from a base and a list of capabilities.
65
65
 
@@ -112,7 +112,7 @@ applies them from left to right.
112
112
  function compose<TMachine, TC1, TC2>(Base, c1, c2): PlayerConstructor<TMachine, TC1 & TC2>;
113
113
  ```
114
114
 
115
- Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/capabilities.ts#L110)
115
+ Defined in: [packages/play-xstate/src/capabilities.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L110)
116
116
 
117
117
  Builds an actor class from a base and a list of capabilities.
118
118
 
@@ -172,7 +172,7 @@ function compose<TMachine, TC1, TC2, TC3>(
172
172
  ): PlayerConstructor<TMachine, TC1 & TC2 & TC3>;
173
173
  ```
174
174
 
175
- Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-xstate/src/capabilities.ts#L115)
175
+ Defined in: [packages/play-xstate/src/capabilities.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-xstate/src/capabilities.ts#L115)
176
176
 
177
177
  Builds an actor class from a base and a list of capabilities.
178
178