@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-router/errors/classes/DuplicateRoutePathError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: DuplicateRoutePathError
4
4
 
5
- Defined in: [packages/play-router/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L135)
5
+ Defined in: [packages/play-router/src/errors.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L135)
6
6
 
7
7
  `detectDuplicateRoutes()` throws this error when two states or more hold the same
8
8
  URL path.
@@ -21,7 +21,7 @@ URL path.
21
21
  new DuplicateRoutePathError(duplicates): DuplicateRoutePathError;
22
22
  ```
23
23
 
24
- Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L139)
24
+ Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L139)
25
25
 
26
26
  #### Parameters
27
27
 
@@ -42,11 +42,11 @@ Defined in: [packages/play-router/src/errors.ts:139](https://gitlab.com/xmachin-
42
42
  | Property | Modifier | Type | Description | Inherited from | Defined in |
43
43
  | ------------------------------------------------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
44
44
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
45
- | <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) |
46
- | <a id="property-duplicates"></a> `duplicates` | `readonly` | `string`[] | The list of the path → state-ID mappings of the conflict, for a person to read. | - | [packages/play-router/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L137) |
45
+ | <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) |
46
+ | <a id="property-duplicates"></a> `duplicates` | `readonly` | `string`[] | The list of the path → state-ID mappings of the conflict, for a person to read. | - | [packages/play-router/src/errors.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L137) |
47
47
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
48
48
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
49
- | <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) |
49
+ | <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) |
50
50
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
51
51
  | <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) | - |
52
52
 
package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: EmptyRoutePathError
4
4
 
5
- Defined in: [packages/play-router/src/errors.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L93)
5
+ Defined in: [packages/play-router/src/errors.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L93)
6
6
 
7
7
  `validateRouteFormat()` throws this error when a state declares a `meta.route`
8
8
  field with an empty string as its path.
@@ -21,7 +21,7 @@ field with an empty string as its path.
21
21
  new EmptyRoutePathError(stateId): EmptyRoutePathError;
22
22
  ```
23
23
 
24
- Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L97)
24
+ Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L97)
25
25
 
26
26
  #### Parameters
27
27
 
@@ -42,12 +42,12 @@ Defined in: [packages/play-router/src/errors.ts:97](https://gitlab.com/xmachin-e
42
42
  | Property | Modifier | Type | Description | Inherited from | Defined in |
43
43
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
44
44
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
45
- | <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) |
45
+ | <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) |
46
46
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
47
47
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
48
- | <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) |
48
+ | <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) |
49
49
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
50
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID with the empty route path. | - | [packages/play-router/src/errors.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L95) |
50
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID with the empty route path. | - | [packages/play-router/src/errors.ts:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L95) |
51
51
  | <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) | - |
52
52
 
53
53
  ## Methods
package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidBasePathError
4
4
 
5
- Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L99)
5
+ Defined in: [packages/play-url/src/errors.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L99)
6
6
 
7
7
  Thrown when a `basePath` option resolves to one concrete URL prefix never.
8
8
 
@@ -45,7 +45,7 @@ try {
45
45
  new InvalidBasePathError(basePath, reason): InvalidBasePathError;
46
46
  ```
47
47
 
48
- Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L103)
48
+ Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L103)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -66,12 +66,12 @@ Defined in: [packages/play-url/src/errors.ts:103](https://gitlab.com/xmachin-es/
66
66
 
67
67
  | Property | Modifier | Type | Description | Inherited from | Defined in |
68
68
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
69
- | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option of the refusal, exactly as the caller gave it. | - | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L101) |
69
+ | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option of the refusal, exactly as the caller gave it. | - | [packages/play-url/src/errors.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L101) |
70
70
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
71
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<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) |
71
+ | <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) |
72
72
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
73
73
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
74
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"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) |
74
+ | <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) |
75
75
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
76
76
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | - |
77
77
 
package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidRoutePatternError
4
4
 
5
- Defined in: [packages/play-url/src/errors.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L45)
5
+ Defined in: [packages/play-url/src/errors.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L45)
6
6
 
7
7
  The library throws this error when `URLPattern` cannot compile the string of a route
8
8
  pattern. The `pattern` field holds the string in question, and `cause` holds the
@@ -48,7 +48,7 @@ try {
48
48
  new InvalidRoutePatternError(pattern, options?): InvalidRoutePatternError;
49
49
  ```
50
50
 
51
- Defined in: [packages/play-url/src/errors.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L55)
51
+ Defined in: [packages/play-url/src/errors.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L55)
52
52
 
53
53
  #### Parameters
54
54
 
@@ -70,11 +70,11 @@ Defined in: [packages/play-url/src/errors.ts:55](https://gitlab.com/xmachin-es/x
70
70
  | Property | Modifier | Type | Description | Inherited from | Defined in |
71
71
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
72
72
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
73
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L56) |
73
+ | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L56) |
74
74
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
75
75
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
76
- | <a id="property-pattern"></a> `pattern` | `readonly` | `string` | The string of the route pattern. URLPattern could not compile it. | - | [packages/play-url/src/errors.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L47) |
77
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L46) |
76
+ | <a id="property-pattern"></a> `pattern` | `readonly` | `string` | The string of the route pattern. URLPattern could not compile it. | - | [packages/play-url/src/errors.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L47) |
77
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46) |
78
78
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
79
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
 
package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: InvalidStateIdError
4
4
 
5
- Defined in: [packages/play-router/src/errors.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L114)
5
+ Defined in: [packages/play-router/src/errors.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L114)
6
6
 
7
7
  `validateStateExists()` throws this error when a route names a state ID that the
8
8
  machine graph does not hold.
@@ -21,7 +21,7 @@ machine graph does not hold.
21
21
  new InvalidStateIdError(stateId): InvalidStateIdError;
22
22
  ```
23
23
 
24
- Defined in: [packages/play-router/src/errors.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L118)
24
+ Defined in: [packages/play-router/src/errors.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L118)
25
25
 
26
26
  #### Parameters
27
27
 
@@ -42,12 +42,12 @@ Defined in: [packages/play-router/src/errors.ts:118](https://gitlab.com/xmachin-
42
42
  | Property | Modifier | Type | Description | Inherited from | Defined in |
43
43
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
44
44
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
45
- | <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) |
45
+ | <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) |
46
46
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
47
47
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
48
- | <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) |
48
+ | <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) |
49
49
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
50
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the reference. The graph does not hold it. | - | [packages/play-router/src/errors.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L116) |
50
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | The state ID of the reference. The graph does not hold it. | - | [packages/play-router/src/errors.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L116) |
51
51
  | <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) | - |
52
52
 
53
53
  ## Methods
package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: MissingBasePathParamError
4
4
 
5
- Defined in: [packages/play-url/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L141)
5
+ Defined in: [packages/play-url/src/errors.ts:141](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L141)
6
6
 
7
7
  Thrown when a `:param` segment of a `basePath` has no value in `basePathParams`.
8
8
 
@@ -43,7 +43,7 @@ try {
43
43
  new MissingBasePathParamError(param, basePath): MissingBasePathParamError;
44
44
  ```
45
45
 
46
- Defined in: [packages/play-url/src/errors.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L147)
46
+ Defined in: [packages/play-url/src/errors.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L147)
47
47
 
48
48
  #### Parameters
49
49
 
@@ -64,13 +64,13 @@ Defined in: [packages/play-url/src/errors.ts:147](https://gitlab.com/xmachin-es/
64
64
 
65
65
  | Property | Modifier | Type | Description | Inherited from | Defined in |
66
66
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
67
- | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option that declares the param. | - | [packages/play-url/src/errors.ts:145](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L145) |
67
+ | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The `basePath` option that declares the param. | - | [packages/play-url/src/errors.ts:145](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L145) |
68
68
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
69
- | <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-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) |
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-param"></a> `param` | `readonly` | `string` | The name of the `:param` segment without a value, and without its `:`. | - | [packages/play-url/src/errors.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/errors.ts#L143) |
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) |
72
+ | <a id="property-param"></a> `param` | `readonly` | `string` | The name of the `:param` segment without a value, and without its `:`. | - | [packages/play-url/src/errors.ts:143](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/errors.ts#L143) |
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-router/errors/classes/RouterSyncError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouterSyncError
4
4
 
5
- Defined in: [packages/play-router/src/errors.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L40)
5
+ Defined in: [packages/play-router/src/errors.ts:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L40)
6
6
 
7
7
  The bridge throws this error when `RouterBridgeBase.syncActorFromRouter()`
8
8
  cannot process a location change of the router and send the `play.route` event to
@@ -38,7 +38,7 @@ try {
38
38
  new RouterSyncError(message, options?): RouterSyncError;
39
39
  ```
40
40
 
41
- Defined in: [packages/play-router/src/errors.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L41)
41
+ Defined in: [packages/play-router/src/errors.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L41)
42
42
 
43
43
  #### Parameters
44
44
 
@@ -60,10 +60,10 @@ Defined in: [packages/play-router/src/errors.ts:41](https://gitlab.com/xmachin-e
60
60
  | Property | Modifier | Type | Description | Inherited from | Defined in |
61
61
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
62
62
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
63
- | <a id="property-code"></a> `code` | `readonly` | `string` | A stable, machine-readable identifier of the error. An error code follows the naming convention `<PACKAGE>_<DESCRIPTION>`, and a Play package writes `PLAY_<PACKAGE>_<DESCRIPTION>`. A code stays the same across each patch release and each minor release of one major version. Never match on `.message`. Always match on `.code`, or on the subclass. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`code`](../../../play/errors/classes/PlayError.md#property-code) | [packages/core/src/errors.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L56) |
63
+ | <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) |
64
64
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
65
65
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
66
- | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/errors.ts#L46) |
66
+ | <a id="property-scope"></a> `scope` | `readonly` | `string` | The class or the module that threw this error, for example `"asDisposable"`. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`scope`](../../../play/errors/classes/PlayError.md#property-scope) | [packages/core/src/errors.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/errors.ts#L46) |
67
67
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
68
68
  | <a id="property-stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stackTraceLimit`](../../../play/errors/classes/PlayError.md#property-stacktracelimit) | - |
69
69
 
package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: UnknownStateTypeError
4
4
 
5
- Defined in: [packages/play-router/src/errors.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L158)
5
+ Defined in: [packages/play-router/src/errors.ts:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L158)
6
6
 
7
7
  `machineToGraph()` throws this error when an XState state node has a `.type` value
8
8
  that the package does not know.
@@ -25,7 +25,7 @@ new UnknownStateTypeError(
25
25
  ): UnknownStateTypeError;
26
26
  ```
27
27
 
28
- Defined in: [packages/play-router/src/errors.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L164)
28
+ Defined in: [packages/play-router/src/errors.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L164)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -48,13 +48,13 @@ Defined in: [packages/play-router/src/errors.ts:164](https://gitlab.com/xmachin-
48
48
  | Property | Modifier | Type | Description | Inherited from | Defined in |
49
49
  | ------------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
50
50
  | <a id="property-cause"></a> `cause?` | `public` | `unknown` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`cause`](../../../play/errors/classes/PlayError.md#property-cause) | - |
51
- | <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) |
51
+ | <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) |
52
52
  | <a id="property-message"></a> `message` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`message`](../../../play/errors/classes/PlayError.md#property-message) | - |
53
53
  | <a id="property-name"></a> `name` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`name`](../../../play/errors/classes/PlayError.md#property-name) | - |
54
- | <a id="property-nodeid"></a> `nodeId` | `readonly` | `string` | The ID of the state node with the unknown type. | - | [packages/play-router/src/errors.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L162) |
55
- | <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) |
54
+ | <a id="property-nodeid"></a> `nodeId` | `readonly` | `string` | The ID of the state node with the unknown type. | - | [packages/play-router/src/errors.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L162) |
55
+ | <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) |
56
56
  | <a id="property-stack"></a> `stack?` | `public` | `string` | - | [`PlayError`](../../../play/errors/classes/PlayError.md).[`stack`](../../../play/errors/classes/PlayError.md#property-stack) | - |
57
- | <a id="property-statetype"></a> `stateType` | `readonly` | `string` | The string of the state type that the package does not know. | - | [packages/play-router/src/errors.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/errors.ts#L160) |
57
+ | <a id="property-statetype"></a> `stateType` | `readonly` | `string` | The string of the state type that the package does not know. | - | [packages/play-router/src/errors.ts:160](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/errors.ts#L160) |
58
58
  | <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) | - |
59
59
 
60
60
  ## Methods
package/api/@xmachines/play-router/index/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L176)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L176)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
64
64
  new RouteMap(mappings, options?): RouteMap;
65
65
  ```
66
66
 
67
- Defined in: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L209)
67
+ Defined in: [packages/play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L209)
68
68
 
69
69
  Builds a route map from an array of the mappings between a state ID and a path.
70
70
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
92
92
  getPathByStateId(stateId): string | null;
93
93
  ```
94
94
 
95
- Defined in: [packages/play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L322)
95
+ Defined in: [packages/play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L322)
96
96
 
97
97
  Returns the path pattern of a state ID.
98
98
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
128
128
  getStateIdByPath(path): string | null;
129
129
  ```
130
130
 
131
- Defined in: [packages/play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/base-route-map.ts#L277)
131
+ Defined in: [packages/play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L277)
132
132
 
133
133
  Resolves a URL path to its state ID.
134
134
 
package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: RouterBridgeBase
4
4
 
5
- Defined in: [packages/play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L124)
5
+ Defined in: [packages/play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L124)
6
6
 
7
7
  A `RouterBridge` whose machine is mounted at a URL prefix that can MOVE while the
8
8
  bridge stays connected.
@@ -53,7 +53,7 @@ new RouterBridgeBase(
53
53
  ): RouterBridgeBase;
54
54
  ```
55
55
 
56
- Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L249)
56
+ Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L249)
57
57
 
58
58
  #### Parameters
59
59
 
@@ -79,7 +79,7 @@ Defined in: [packages/play-router/src/router-bridge-base.ts:249](https://gitlab.
79
79
  get basePath(): string;
80
80
  ```
81
81
 
82
- Defined in: [packages/play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L282)
82
+ Defined in: [packages/play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L282)
83
83
 
84
84
  The resolved URL prefix that the machine of this bridge is mounted under, or `""`
85
85
  when the machine owns the complete router.
@@ -104,7 +104,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
104
104
  get basePathParams(): Readonly<Record<string, string>>;
105
105
  ```
106
106
 
107
- Defined in: [packages/play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L311)
107
+ Defined in: [packages/play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L311)
108
108
 
109
109
  The resolved values of the `:param` segments of the mount, or `{}` for a prefix
110
110
  without a param.
@@ -155,7 +155,7 @@ mount while the machine stays on the same route, and no event goes out.
155
155
  connect(): void;
156
156
  ```
157
157
 
158
- Defined in: [packages/play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L533)
158
+ Defined in: [packages/play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L533)
159
159
 
160
160
  Connects the router bridge to the Actor.
161
161
 
@@ -189,7 +189,7 @@ An adapter that needs a different behavior of the first synchronization override
189
189
  disconnect(): void;
190
190
  ```
191
191
 
192
- Defined in: [packages/play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L791)
192
+ Defined in: [packages/play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L791)
193
193
 
194
194
  Disconnects the router bridge from the Actor.
195
195
 
@@ -212,7 +212,7 @@ framework.
212
212
  setBasePath(basePath?, basePathParams?): void;
213
213
  ```
214
214
 
215
- Defined in: [packages/play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-bridge-base.ts#L351)
215
+ Defined in: [packages/play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L351)
216
216
 
217
217
  Moves the machine to a different mount point, while it stays connected.
218
218
 
package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md CHANGED
@@ -9,7 +9,7 @@ function buildPlayRouteEvent(options): {
9
9
  } | null;
10
10
  ```
11
11
 
12
- Defined in: [packages/play-router/src/router-sync.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/router-sync.ts#L162)
12
+ Defined in: [packages/play-router/src/router-sync.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-sync.ts#L162)
13
13
 
14
14
  Builds a normalized `play.route` event from the raw input of a router or of a
15
15
  browser.
package/api/@xmachines/play-router/index/functions/buildRouteTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function buildRouteTree<TGraph>(routes): RouteTree<TGraph>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-router/src/build-tree.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-router/src/build-tree.ts#L38)
9
+ Defined in: [packages/play-router/src/build-tree.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/build-tree.ts#L38)
10
10
 
11
11
  Builds the hierarchical route tree from the flat list of the routes
12
12
 
package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function cleanFrameworkParams(params): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-url/src/framework-params.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/play-url/src/framework-params.ts#L108)
9
+ Defined in: [packages/play-url/src/framework-params.ts:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/framework-params.ts#L108)
10
10
 
11
11
  The params of a framework router, in the shape that [pickOwnParams](pickOwnParams.md) reads.
12
12
 
package/api/@xmachines/play-router/index/functions/createLruCache.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createLruCache<V>(maxSize?): KeyValueCache<V>;
7
7
  ```
8
8
 
9
- Defined in: [packages/core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.0.0/packages/core/src/cache.ts#L54)
9
+ Defined in: [packages/core/src/cache.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/core/src/cache.ts#L54)
10
10
 
11
11
  Builds a cache that forgets its least recently used entries.
12
12