@xmachines/docs 1.0.0-beta.13 → 1.0.0-beta.15

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 (131) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +15 -15
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +5 -5
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +5 -5
  6. package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
  7. package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
  8. package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
  9. package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
  10. package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
  11. package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
  12. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
  19. package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
  20. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  21. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  22. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  24. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  25. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  26. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  27. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
  29. package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
  30. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  31. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  32. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  33. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  34. package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
  35. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  36. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  37. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  38. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  39. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  40. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  41. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  42. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +5 -5
  43. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +16 -16
  44. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +16 -16
  45. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +6 -6
  46. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  47. package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
  48. package/api/@xmachines/play-router/interfaces/RouteMap.md +6 -6
  49. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  50. package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
  51. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  52. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  53. package/api/@xmachines/play-router/interfaces/StateVisit.md +6 -6
  54. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +6 -6
  55. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  56. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
  57. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
  59. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  60. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  61. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  62. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  63. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  64. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  65. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  66. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  67. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  69. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  70. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  71. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  72. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  73. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  74. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  75. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  76. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  77. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  78. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  79. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  80. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
  81. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  82. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  83. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  84. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  85. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  86. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  87. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  88. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  89. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  90. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  91. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  92. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  93. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  94. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  95. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  96. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
  97. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +6 -6
  99. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  100. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-xstate/classes/PlayerActor.md +23 -23
  102. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  103. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  104. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  105. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  106. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  107. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  108. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  109. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  110. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  111. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  112. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  113. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  114. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  115. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  116. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +5 -5
  117. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +6 -6
  118. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +9 -9
  119. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
  120. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  121. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  122. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  123. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  124. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  125. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  126. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  127. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  128. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  129. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +4 -4
  130. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  131. package/package.json +2 -2
package/api/@xmachines/play-router/classes/BaseRouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: BaseRouteMap
4
4
 
5
- Defined in: [base-route-map.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L70)
5
+ Defined in: [base-route-map.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L70)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -57,7 +57,7 @@ map.getPathByStateId("missing"); // null
57
57
  new BaseRouteMap(mappings): BaseRouteMap;
58
58
  ```
59
59
 
60
- Defined in: [base-route-map.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L86)
60
+ Defined in: [base-route-map.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L86)
61
61
 
62
62
  Build a route map from an array of state ID ↔ path mappings.
63
63
 
@@ -83,7 +83,7 @@ buckets for efficient candidate selection.
83
83
  getPathByStateId(stateId): string | null;
84
84
  ```
85
85
 
86
- Defined in: [base-route-map.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L164)
86
+ Defined in: [base-route-map.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L164)
87
87
 
88
88
  Look up the path pattern registered for a state ID.
89
89
 
@@ -114,7 +114,7 @@ map.getPathByStateId("missing"); // null
114
114
  getStateIdByPath(path): string | null;
115
115
  ```
116
116
 
117
- Defined in: [base-route-map.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L130)
117
+ Defined in: [base-route-map.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L130)
118
118
 
119
119
  Resolve a URL path to its mapped state ID.
120
120
 
package/api/@xmachines/play-router/classes/RouterBridgeBase.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: RouterBridgeBase
4
4
 
5
- Defined in: [router-bridge-base.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L56)
5
+ Defined in: [router-bridge-base.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L56)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -30,7 +30,7 @@ between frameworks.
30
30
  new RouterBridgeBase(actor, routeMap): RouterBridgeBase;
31
31
  ```
32
32
 
33
- Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L70)
33
+ Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L70)
34
34
 
35
35
  Constructor receives the 3 things all bridges need.
36
36
 
@@ -49,17 +49,17 @@ Constructor receives the 3 things all bridges need.
49
49
 
50
50
  ## Properties
51
51
 
52
- | Property | Modifier | Type | Default value | Description | Defined in |
53
- | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | Actor with currentRoute signal and send method | [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L71) |
55
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L59) |
56
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L58) |
57
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L61) |
58
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | `""` | - | [router-bridge-base.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L60) |
59
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for stateId ↔ path resolution | [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L72) |
60
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L74) |
61
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L73) |
62
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | `null` | - | [router-bridge-base.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L62) |
52
+ | Property | Modifier | Type | Default value | Description | Defined in |
53
+ | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
54
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | Actor with currentRoute signal and send method | [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L71) |
55
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L59) |
56
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L58) |
57
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L61) |
58
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | `""` | - | [router-bridge-base.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L60) |
59
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for stateId ↔ path resolution | [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L72) |
60
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L74) |
61
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L73) |
62
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | `null` | - | [router-bridge-base.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L62) |
63
63
 
64
64
  ## Methods
65
65
 
@@ -69,7 +69,7 @@ Constructor receives the 3 things all bridges need.
69
69
  connect(): void;
70
70
  ```
71
71
 
72
- Defined in: [router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L90)
72
+ Defined in: [router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L90)
73
73
 
74
74
  Connect the router bridge to the Actor.
75
75
 
@@ -92,7 +92,7 @@ starts watching router changes (framework-specific).
92
92
  disconnect(): void;
93
93
  ```
94
94
 
95
- Defined in: [router-bridge-base.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L140)
95
+ Defined in: [router-bridge-base.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L140)
96
96
 
97
97
  Disconnect the router bridge from the Actor.
98
98
 
@@ -114,7 +114,7 @@ Stops signal watching and unregisters framework-specific router listener.
114
114
  protected extractParams(pathname, stateId): Record<string, string>;
115
115
  ```
116
116
 
117
- Defined in: [router-bridge-base.ts:276](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L276)
117
+ Defined in: [router-bridge-base.ts:276](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L276)
118
118
 
119
119
  Extract path parameters from URL using the URLPattern API.
120
120
 
@@ -144,7 +144,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
144
144
  protected extractQuery(search): Record<string, string>;
145
145
  ```
146
146
 
147
- Defined in: [router-bridge-base.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L303)
147
+ Defined in: [router-bridge-base.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L303)
148
148
 
149
149
  Extract query parameters from URL search string.
150
150
 
@@ -168,7 +168,7 @@ Extracted query parameters or empty object
168
168
  protected getInitialRouterPath(): string | null;
169
169
  ```
170
170
 
171
- Defined in: [router-bridge-base.ts:353](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L353)
171
+ Defined in: [router-bridge-base.ts:353](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L353)
172
172
 
173
173
  Return the router's current pathname at connect() time, or null if unavailable.
174
174
 
@@ -194,7 +194,7 @@ previous behaviour for bridges that have not yet implemented this hook.
194
194
  abstract protected navigateRouter(path): void;
195
195
  ```
196
196
 
197
- Defined in: [router-bridge-base.ts:323](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L323)
197
+ Defined in: [router-bridge-base.ts:323](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L323)
198
198
 
199
199
  Navigate the framework router to the given path.
200
200
 
@@ -219,7 +219,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
219
219
  protected syncActorFromRouter(pathname, search?): void;
220
220
  ```
221
221
 
222
- Defined in: [router-bridge-base.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L187)
222
+ Defined in: [router-bridge-base.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L187)
223
223
 
224
224
  Sync actor state when router location changes.
225
225
 
@@ -245,7 +245,7 @@ Prevents circular updates via isProcessingNavigation flag.
245
245
  protected syncRouterFromActor(route): void;
246
246
  ```
247
247
 
248
- Defined in: [router-bridge-base.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L167)
248
+ Defined in: [router-bridge-base.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L167)
249
249
 
250
250
  Sync router location when actor route signal changes.
251
251
 
@@ -270,7 +270,7 @@ Prevents circular updates via isProcessingNavigation flag.
270
270
  abstract protected unwatchRouterChanges(): void;
271
271
  ```
272
272
 
273
- Defined in: [router-bridge-base.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L338)
273
+ Defined in: [router-bridge-base.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L338)
274
274
 
275
275
  Stop watching for router location changes.
276
276
 
@@ -288,7 +288,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
288
288
  abstract protected watchRouterChanges(): void;
289
289
  ```
290
290
 
291
- Defined in: [router-bridge-base.ts:331](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/router-bridge-base.ts#L331)
291
+ Defined in: [router-bridge-base.ts:331](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/router-bridge-base.ts#L331)
292
292
 
293
293
  Start watching for router location changes.
294
294
 
package/api/@xmachines/play-router/functions/buildRouteTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function buildRouteTree(routes): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/build-tree.ts#L13)
9
+ Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/build-tree.ts#L13)
10
10
 
11
11
  Build hierarchical route tree from flat route list
12
12
 
package/api/@xmachines/play-router/functions/connectRouter.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [connect-router.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/connect-router.ts#L58)
9
+ Defined in: [connect-router.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/connect-router.ts#L58)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
package/api/@xmachines/play-router/functions/crawlMachine.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function crawlMachine(machine): StateVisit[];
7
7
  ```
8
8
 
9
- Defined in: [crawl-machine.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/crawl-machine.ts#L74)
9
+ Defined in: [crawl-machine.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/crawl-machine.ts#L74)
10
10
 
11
11
  Crawl state machine graph using breadth-first traversal
12
12
 
package/api/@xmachines/play-router/functions/createBrowserHistory.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [create-browser-history.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L99)
9
+ Defined in: [create-browser-history.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L99)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
package/api/@xmachines/play-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [create-route-map.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-route-map.ts#L120)
9
+ Defined in: [create-route-map.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-route-map.ts#L120)
10
10
 
11
11
  Create a RouteMap from a RouteTree for efficient path lookups.
12
12
 
package/api/@xmachines/play-router/functions/createRouter.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [create-router.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-router.ts#L73)
9
+ Defined in: [create-router.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-router.ts#L73)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function detectDuplicateRoutes(routes): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/validate-routes.ts#L51)
9
+ Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/validate-routes.ts#L51)
10
10
 
11
11
  Detect duplicate route paths
12
12
 
package/api/@xmachines/play-router/functions/extractMachineRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [extract-routes.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/extract-routes.ts#L45)
9
+ Defined in: [extract-routes.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/extract-routes.ts#L45)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
package/api/@xmachines/play-router/functions/extractRoute.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function extractRoute(node, path, stateMap): RouteInfo | null;
7
7
  ```
8
8
 
9
- Defined in: [extract-route.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/extract-route.ts#L26)
9
+ Defined in: [extract-route.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/extract-route.ts#L26)
10
10
 
11
11
  Extract route information from state node with validation
12
12
 
package/api/@xmachines/play-router/functions/findRouteById.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function findRouteById(tree, id): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [index.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/index.ts#L69)
9
+ Defined in: [index.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/index.ts#L69)
10
10
 
11
11
  Find route node by state ID
12
12
 
package/api/@xmachines/play-router/functions/findRouteByPath.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function findRouteByPath(tree, path): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [index.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/index.ts#L161)
9
+ Defined in: [index.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/index.ts#L161)
10
10
 
11
11
  Find route node by URL path
12
12
 
package/api/@xmachines/play-router/functions/getNavigableRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getNavigableRoutes(tree, stateId): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/query.ts#L20)
9
+ Defined in: [query.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/query.ts#L20)
10
10
 
11
11
  Get all routes navigable from given state
12
12
 
package/api/@xmachines/play-router/functions/getRoutableRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getRoutableRoutes(tree): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/query.ts#L50)
9
+ Defined in: [query.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/query.ts#L50)
10
10
 
11
11
  Get all routable routes from tree as flat array
12
12
 
package/api/@xmachines/play-router/functions/routeExists.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function routeExists(tree, path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [query.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/query.ts#L72)
9
+ Defined in: [query.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/query.ts#L72)
10
10
 
11
11
  Validate route path exists in tree
12
12
 
package/api/@xmachines/play-router/functions/validateRouteFormat.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function validateRouteFormat(routePath, stateId): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/validate-routes.ts#L14)
9
+ Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/validate-routes.ts#L14)
10
10
 
11
11
  Validate route path format
12
12
 
package/api/@xmachines/play-router/functions/validateStateExists.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function validateStateExists(stateId, stateMap): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/validate-routes.ts#L32)
9
+ Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/validate-routes.ts#L32)
10
10
 
11
11
  Validate state exists in state map
12
12
 
package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseRouteMapping
4
4
 
5
- Defined in: [base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L28)
5
+ Defined in: [base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L28)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -21,7 +21,7 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Modifier | Type | Description | Defined in |
25
- | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L32) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/base-route-map.ts#L30) |
24
+ | Property | Modifier | Type | Description | Defined in |
25
+ | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L32) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/base-route-map.ts#L30) |
package/api/@xmachines/play-router/interfaces/BrowserHistory.md CHANGED
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L1)
5
+ Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
- | Property | Modifier | Type | Description | Defined in |
10
- | ----------------------------------------- | ---------- | --------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L9) |
9
+ | Property | Modifier | Type | Description | Defined in |
10
+ | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachine
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L26)
25
+ Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachin
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L38)
39
+ Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [create-browser-history.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L43)
61
+ Defined in: [create-browser-history.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L43)
62
62
 
63
63
  Cleanup
64
64
 
@@ -74,7 +74,7 @@ Cleanup
74
74
  forward(): void;
75
75
  ```
76
76
 
77
- Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L27)
77
+ Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L27)
78
78
 
79
79
  #### Returns
80
80
 
@@ -88,7 +88,7 @@ Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachin
88
88
  go(delta): void;
89
89
  ```
90
90
 
91
- Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L25)
91
+ Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L25)
92
92
 
93
93
  Go back/forward
94
94
 
@@ -110,7 +110,7 @@ Go back/forward
110
110
  push(path, state?): void;
111
111
  ```
112
112
 
113
- Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L15)
113
+ Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L15)
114
114
 
115
115
  Push new URL to history
116
116
 
@@ -133,7 +133,7 @@ Push new URL to history
133
133
  replace(path, state?): void;
134
134
  ```
135
135
 
136
- Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L20)
136
+ Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L20)
137
137
 
138
138
  Replace current URL in history
139
139
 
@@ -156,7 +156,7 @@ Replace current URL in history
156
156
  subscribe(listener): () => void;
157
157
  ```
158
158
 
159
- Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L33)
159
+ Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L33)
160
160
 
161
161
  Subscribe to history changes
162
162
  Returns unsubscribe function
package/api/@xmachines/play-router/interfaces/BrowserWindow.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BrowserWindow
4
4
 
5
- Defined in: [create-browser-history.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L55)
5
+ Defined in: [create-browser-history.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L55)
6
6
 
7
7
  Minimal window interface for createBrowserHistory
8
8
 
@@ -12,19 +12,19 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Modifier | Type | Defined in |
16
- | ----------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-history"></a> `history` | `public` | `object` | [create-browser-history.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L56) |
18
- | `history.state` | `readonly` | `unknown` | [create-browser-history.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L57) |
19
- | `history.back` | `public` | `void` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L61) |
20
- | `history.forward` | `public` | `void` | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L62) |
21
- | `history.go` | `public` | `void` | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L60) |
22
- | `history.pushState` | `public` | `void` | [create-browser-history.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L58) |
23
- | `history.replaceState` | `public` | `void` | [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L59) |
24
- | <a id="property-location"></a> `location` | `public` | `object` | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L64) |
25
- | `location.hash` | `readonly` | `string` | [create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L67) |
26
- | `location.pathname` | `readonly` | `string` | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L65) |
27
- | `location.search` | `readonly` | `string` | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L66) |
15
+ | Property | Modifier | Type | Defined in |
16
+ | ----------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | <a id="property-history"></a> `history` | `public` | `object` | [create-browser-history.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L56) |
18
+ | `history.state` | `readonly` | `unknown` | [create-browser-history.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L57) |
19
+ | `history.back` | `public` | `void` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L61) |
20
+ | `history.forward` | `public` | `void` | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L62) |
21
+ | `history.go` | `public` | `void` | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L60) |
22
+ | `history.pushState` | `public` | `void` | [create-browser-history.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L58) |
23
+ | `history.replaceState` | `public` | `void` | [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L59) |
24
+ | <a id="property-location"></a> `location` | `public` | `object` | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L64) |
25
+ | `location.hash` | `readonly` | `string` | [create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L67) |
26
+ | `location.pathname` | `readonly` | `string` | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L65) |
27
+ | `location.search` | `readonly` | `string` | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L66) |
28
28
 
29
29
  ## Methods
30
30
 
@@ -34,7 +34,7 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
34
34
  addEventListener(type, listener): void;
35
35
  ```
36
36
 
37
- Defined in: [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L69)
37
+ Defined in: [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L69)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -55,7 +55,7 @@ Defined in: [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachin
55
55
  removeEventListener(type, listener): void;
56
56
  ```
57
57
 
58
- Defined in: [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-browser-history.ts#L70)
58
+ Defined in: [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/create-browser-history.ts#L70)
59
59
 
60
60
  #### Parameters
61
61
 
package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/connect-router.ts#L7)
5
+ Defined in: [connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/connect-router.ts#L7)
6
6
 
7
7
  ## Properties
8
8
 
9
- | Property | Type | Defined in |
10
- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/connect-router.ts#L8) |
12
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md) | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/connect-router.ts#L10) |
13
- | <a id="property-router"></a> `router` | [`VanillaRouter`](VanillaRouter.md) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/connect-router.ts#L9) |
9
+ | Property | Type | Defined in |
10
+ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/connect-router.ts#L8) |
12
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md) | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/connect-router.ts#L10) |
13
+ | <a id="property-router"></a> `router` | [`VanillaRouter`](VanillaRouter.md) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.15/packages/play-router/src/connect-router.ts#L9) |