@xmachines/docs 1.0.0-beta.14 → 1.0.0-beta.16
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.
- package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
- package/api/@xmachines/play-actor/classes/AbstractActor.md +50 -39
- package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
- package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +5 -5
- package/api/@xmachines/play-actor/interfaces/Viewable.md +5 -5
- package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
- package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +12 -38
- package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
- package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
- package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
- package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
- package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +34 -28
- package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
- package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +5 -5
- package/api/@xmachines/play-router/interfaces/BrowserHistory.md +16 -16
- package/api/@xmachines/play-router/interfaces/BrowserWindow.md +16 -16
- package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +6 -6
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteMap.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
- package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/interfaces/StateVisit.md +6 -6
- package/api/@xmachines/play-router/interfaces/VanillaRouter.md +6 -6
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -9
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +3 -11
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +5 -7
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +3 -13
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +0 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +0 -2
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +48 -35
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +11 -11
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +6 -6
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/README.md +19 -1
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +65 -46
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +5 -5
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +6 -6
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +22 -0
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +9 -9
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
- package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +6 -5
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
- package/api/@xmachines/shared/functions/defineXmVitestConfig.md +4 -4
- package/api/@xmachines/shared/functions/xmAliases.md +1 -1
- package/examples/README.md +20 -6
- package/examples/multi-router-integration.md +2 -5
- package/examples/routing-patterns.md +2 -3
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type PlayEvent<TPayload> = object & TPayload;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play/src/types.ts#L69)
|
|
10
10
|
|
|
11
11
|
Generic event type for Play Architecture
|
|
12
12
|
|
|
@@ -32,9 +32,9 @@ Robot, and other state machine libraries.
|
|
|
32
32
|
|
|
33
33
|
## Type Declaration
|
|
34
34
|
|
|
35
|
-
| Name | Type | Defined in
|
|
36
|
-
| ------ | -------- |
|
|
37
|
-
| `type` | `string` | [types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
| Name | Type | Defined in |
|
|
36
|
+
| ------ | -------- | -------------------------------------------------------------------------------------------------------------- |
|
|
37
|
+
| `type` | `string` | [types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play/src/types.ts#L70) |
|
|
38
38
|
|
|
39
39
|
## Type Parameters
|
|
40
40
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Abstract Class: AbstractActor\<TLogic\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-actor/src/abstract-actor.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-actor/src/abstract-actor.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L187)
|
|
6
6
|
|
|
7
7
|
Abstract base class for Play Architecture actors.
|
|
8
8
|
|
|
@@ -82,8 +82,6 @@ class PlayerActor extends AbstractActor<AnyActorLogic> implements Routable, View
|
|
|
82
82
|
new AbstractActor<TLogic>(logic, options?): AbstractActor<TLogic>;
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:50
|
|
86
|
-
|
|
87
85
|
Creates a new actor instance for the given logic with the provided options,
|
|
88
86
|
if any.
|
|
89
87
|
|
|
@@ -106,19 +104,19 @@ Actor<TLogic>.constructor
|
|
|
106
104
|
|
|
107
105
|
## Properties
|
|
108
106
|
|
|
109
|
-
| Property | Modifier | Type | Description | Inherited from | Defined in
|
|
110
|
-
| ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
|
|
111
|
-
| <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | `Actor._parent` |
|
|
112
|
-
| <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` |
|
|
113
|
-
| <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` |
|
|
114
|
-
| <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` |
|
|
115
|
-
| <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` |
|
|
116
|
-
| <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` |
|
|
117
|
-
| <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` |
|
|
118
|
-
| <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` |
|
|
119
|
-
| <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
120
|
-
| <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` |
|
|
121
|
-
| <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` |
|
|
107
|
+
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
108
|
+
| ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
109
|
+
| <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | `Actor._parent` | - |
|
|
110
|
+
| <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` | - |
|
|
111
|
+
| <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` | - |
|
|
112
|
+
| <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` | - |
|
|
113
|
+
| <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` | - |
|
|
114
|
+
| <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
|
|
115
|
+
| <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
|
|
116
|
+
| <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
|
|
117
|
+
| <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L207) |
|
|
118
|
+
| <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
|
|
119
|
+
| <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
|
|
122
120
|
|
|
123
121
|
## Methods
|
|
124
122
|
|
|
@@ -128,8 +126,6 @@ Actor<TLogic>.constructor
|
|
|
128
126
|
observable: InteropSubscribable<SnapshotFrom<TLogic>>;
|
|
129
127
|
```
|
|
130
128
|
|
|
131
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:153
|
|
132
|
-
|
|
133
129
|
#### Returns
|
|
134
130
|
|
|
135
131
|
[`InteropSubscribable`](https://www.jsdocs.io/package/xstate#InteropSubscribable)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>\>
|
|
@@ -148,8 +144,6 @@ Actor.[observable]
|
|
|
148
144
|
getPersistedSnapshot(): Snapshot<unknown>;
|
|
149
145
|
```
|
|
150
146
|
|
|
151
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:152
|
|
152
|
-
|
|
153
147
|
Obtain the internal state of the actor, which can be persisted.
|
|
154
148
|
|
|
155
149
|
#### Returns
|
|
@@ -184,8 +178,6 @@ Actor.getPersistedSnapshot;
|
|
|
184
178
|
getSnapshot(): SnapshotFrom<TLogic>;
|
|
185
179
|
```
|
|
186
180
|
|
|
187
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:168
|
|
188
|
-
|
|
189
181
|
Read an actor’s snapshot synchronously.
|
|
190
182
|
|
|
191
183
|
#### Returns
|
|
@@ -221,8 +213,6 @@ Actor.getSnapshot;
|
|
|
221
213
|
on<TType>(type, handler): Subscription;
|
|
222
214
|
```
|
|
223
215
|
|
|
224
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:115
|
|
225
|
-
|
|
226
216
|
#### Type Parameters
|
|
227
217
|
|
|
228
218
|
| Type Parameter |
|
|
@@ -248,13 +238,44 @@ Actor.on;
|
|
|
248
238
|
|
|
249
239
|
---
|
|
250
240
|
|
|
241
|
+
### select()
|
|
242
|
+
|
|
243
|
+
```ts
|
|
244
|
+
select<TSelected>(selector, equalityFn?): Readable<TSelected>;
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
#### Type Parameters
|
|
248
|
+
|
|
249
|
+
| Type Parameter |
|
|
250
|
+
| -------------- |
|
|
251
|
+
| `TSelected` |
|
|
252
|
+
|
|
253
|
+
#### Parameters
|
|
254
|
+
|
|
255
|
+
| Parameter | Type |
|
|
256
|
+
| ------------- | --------------------------- |
|
|
257
|
+
| `selector` | (`snapshot`) => `TSelected` |
|
|
258
|
+
| `equalityFn?` | (`a`, `b`) => `boolean` |
|
|
259
|
+
|
|
260
|
+
#### Returns
|
|
261
|
+
|
|
262
|
+
`Readable`\<`TSelected`\>
|
|
263
|
+
|
|
264
|
+
#### Inherited from
|
|
265
|
+
|
|
266
|
+
```ts
|
|
267
|
+
Actor.select;
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
---
|
|
271
|
+
|
|
251
272
|
### send()
|
|
252
273
|
|
|
253
274
|
```ts
|
|
254
275
|
abstract send(event): void;
|
|
255
276
|
```
|
|
256
277
|
|
|
257
|
-
Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
278
|
+
Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L231)
|
|
258
279
|
|
|
259
280
|
Send event to Actor
|
|
260
281
|
|
|
@@ -299,8 +320,6 @@ Actor.send;
|
|
|
299
320
|
start(): this;
|
|
300
321
|
```
|
|
301
322
|
|
|
302
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:119
|
|
303
|
-
|
|
304
323
|
Starts the Actor from the initial state
|
|
305
324
|
|
|
306
325
|
#### Returns
|
|
@@ -321,8 +340,6 @@ Actor.start;
|
|
|
321
340
|
stop(): this;
|
|
322
341
|
```
|
|
323
342
|
|
|
324
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:123
|
|
325
|
-
|
|
326
343
|
Stops the Actor and unsubscribe all listeners.
|
|
327
344
|
|
|
328
345
|
#### Returns
|
|
@@ -345,8 +362,6 @@ Actor.stop;
|
|
|
345
362
|
subscribe(observer): Subscription;
|
|
346
363
|
```
|
|
347
364
|
|
|
348
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:113
|
|
349
|
-
|
|
350
365
|
Subscribe an observer to an actor’s snapshot values.
|
|
351
366
|
|
|
352
367
|
##### Parameters
|
|
@@ -423,8 +438,6 @@ subscribe(
|
|
|
423
438
|
completeListener?): Subscription;
|
|
424
439
|
```
|
|
425
440
|
|
|
426
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:114
|
|
427
|
-
|
|
428
441
|
Subscribe an observer to an actor’s snapshot values.
|
|
429
442
|
|
|
430
443
|
##### Parameters
|
|
@@ -502,16 +515,14 @@ Actor.subscribe;
|
|
|
502
515
|
toJSON(): object;
|
|
503
516
|
```
|
|
504
517
|
|
|
505
|
-
Defined in: node_modules/xstate/dist/declarations/src/createActor.d.ts:135
|
|
506
|
-
|
|
507
518
|
#### Returns
|
|
508
519
|
|
|
509
520
|
`object`
|
|
510
521
|
|
|
511
|
-
| Name | Type | Defined in
|
|
512
|
-
| -------------- | -------- |
|
|
513
|
-
| `id` | `string` |
|
|
514
|
-
| `xstate$$type` | `number` |
|
|
522
|
+
| Name | Type | Defined in |
|
|
523
|
+
| -------------- | -------- | ---------- |
|
|
524
|
+
| `id` | `string` | - |
|
|
525
|
+
| `xstate$$type` | `number` | - |
|
|
515
526
|
|
|
516
527
|
#### Inherited from
|
|
517
528
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: Routable
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-actor/src/abstract-actor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-actor/src/abstract-actor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L41)
|
|
6
6
|
|
|
7
7
|
Optional capability: Routing support
|
|
8
8
|
|
|
@@ -24,6 +24,6 @@ function connectRouter<T extends AbstractActor & Routable>(actor: T) {
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Modifier | Type | Description | Defined in
|
|
28
|
-
| ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
29
|
-
| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | [packages/play-actor/src/abstract-actor.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
27
|
+
| Property | Modifier | Type | Description | Defined in |
|
|
28
|
+
| ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | [packages/play-actor/src/abstract-actor.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L58) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ViewMetadata
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-actor/src/abstract-actor.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-actor/src/abstract-actor.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L87)
|
|
6
6
|
|
|
7
7
|
View metadata for rendering
|
|
8
8
|
|
|
@@ -11,7 +11,7 @@ Used by PlayRenderer to dynamically render UI based on actor state.
|
|
|
11
11
|
|
|
12
12
|
## Properties
|
|
13
13
|
|
|
14
|
-
| Property | Type | Description | Defined in
|
|
15
|
-
| ------------------------------------------- | ------------------------------- | ------------------------------------------------ |
|
|
16
|
-
| <a id="property-component"></a> `component` | `string` | Name of the component to render from the catalog | [packages/play-actor/src/abstract-actor.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
17
|
-
| <a id="property-props"></a> `props` | `Record`\<`string`, `unknown`\> | Props to pass to the component | [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
14
|
+
| Property | Type | Description | Defined in |
|
|
15
|
+
| ------------------------------------------- | ------------------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
16
|
+
| <a id="property-component"></a> `component` | `string` | Name of the component to render from the catalog | [packages/play-actor/src/abstract-actor.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L89) |
|
|
17
|
+
| <a id="property-props"></a> `props` | `Record`\<`string`, `unknown`\> | Props to pass to the component | [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L91) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: Viewable
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L102)
|
|
6
6
|
|
|
7
7
|
Actor capability for exposing renderable view state.
|
|
8
8
|
|
|
@@ -13,7 +13,7 @@ framework adapter.
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
| Property | Modifier | Type | Description | Defined in
|
|
17
|
-
| ----------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
-
| <a id="property-catalog"></a> `catalog` | `readonly` | `Record`\<`string`, `unknown`\> | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
19
|
-
| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | [packages/play-actor/src/abstract-actor.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
16
|
+
| Property | Modifier | Type | Description | Defined in |
|
|
17
|
+
| ----------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| <a id="property-catalog"></a> `catalog` | `readonly` | `Record`\<`string`, `unknown`\> | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L127) |
|
|
19
|
+
| <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | [packages/play-actor/src/abstract-actor.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-actor/src/abstract-actor.ts#L119) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function defineCatalog<TCatalog>(schemas): TCatalog;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [define-catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [define-catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/define-catalog.ts#L74)
|
|
10
10
|
|
|
11
11
|
Define component catalog with Zod schemas for type-safe UI projection
|
|
12
12
|
|
|
@@ -9,7 +9,7 @@ function defineComponents<TCatalog, TComponents>(
|
|
|
9
9
|
): NoExtraKeys<TComponents, TCatalog>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [define-components.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
12
|
+
Defined in: [define-components.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/define-components.ts#L116)
|
|
13
13
|
|
|
14
14
|
Define components matching catalog schema with compile-time validation
|
|
15
15
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type Catalog<TCatalog> = TCatalog;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/types.ts#L35)
|
|
10
10
|
|
|
11
11
|
Component catalog mapping component names to Zod prop schemas
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type ComponentsFor<TCatalog> = { [K in keyof TCatalog]: unknown };
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [define-components.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [define-components.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/define-components.ts#L10)
|
|
10
10
|
|
|
11
11
|
Component map type enforcing catalog keys
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type InferComponentProps<TCatalog, TKey> = z.infer<TCatalog[TKey]>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/types.ts#L84)
|
|
10
10
|
|
|
11
11
|
Infer component prop types from catalog entry
|
|
12
12
|
|
|
@@ -7,7 +7,7 @@ type NoExtraKeys<TComponents, TCatalog> = TComponents &
|
|
|
7
7
|
Record<Exclude<keyof TComponents, keyof TCatalog>, never>;
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
Defined in: [define-components.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
10
|
+
Defined in: [define-components.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-catalog/src/define-components.ts#L14)
|
|
11
11
|
|
|
12
12
|
## Type Parameters
|
|
13
13
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: PlayErrorBoundary
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L49)
|
|
6
6
|
|
|
7
7
|
React class component error boundary for catching catalog component render errors.
|
|
8
8
|
|
|
@@ -32,7 +32,7 @@ Per CONS-14: Class component pattern works with all React versions (18 and 19).
|
|
|
32
32
|
new PlayErrorBoundary(props): PlayErrorBoundary;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L53)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -55,13 +55,13 @@ React.Component<
|
|
|
55
55
|
|
|
56
56
|
## Properties
|
|
57
57
|
|
|
58
|
-
| Property | Modifier | Type | Description | Inherited from | Defined in
|
|
59
|
-
| ------------------------------------------------ | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- |
|
|
60
|
-
| <a id="property-context"></a> `context` | `public` | `unknown` | If using React Context, re-declare this in your class to be the `React.ContextType` of your `static contextType`. Should be used with type annotation or static contextType. **Example** `static contextType = MyContext // For TS pre-3.7: context!: React.ContextType<typeof MyContext> // For TS 3.7 and above: declare context: React.ContextType<typeof MyContext>` **See** [React Docs](https://react.dev/reference/react/Component#context) | `React.Component.context` |
|
|
61
|
-
| <a id="property-props"></a> `props` | `readonly` | `Readonly`\<`P`\> | - | `React.Component.props` |
|
|
62
|
-
| <a id="property-state"></a> `state` | `public` | `Readonly`\<`S`\> | - | `React.Component.state` |
|
|
63
|
-
| <a id="property-contexttype"></a> `contextType?` | `static` | `Context`\<`any`\> | If set, `this.context` will be set at runtime to the current value of the given Context. **Example** `type MyContext = number const Ctx = React.createContext<MyContext>(0) class Foo extends React.Component { static contextType = Ctx context!: React.ContextType<typeof Ctx> render () { return <>My context's value: {this.context}</>; } }` **See** [https://react.dev/reference/react/Component#static-contexttype](https://react.dev/reference/react/Component#static-contexttype) | `React.Component.contextType` |
|
|
64
|
-
| <a id="property-proptypes"></a> ~~`propTypes?`~~ | `static` | `any` | Ignored by React. **Deprecated** Only kept in types for backwards compatibility. Will be removed in a future major release. | `React.Component.propTypes` |
|
|
58
|
+
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
59
|
+
| ------------------------------------------------ | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | ---------- |
|
|
60
|
+
| <a id="property-context"></a> `context` | `public` | `unknown` | If using React Context, re-declare this in your class to be the `React.ContextType` of your `static contextType`. Should be used with type annotation or static contextType. **Example** `static contextType = MyContext // For TS pre-3.7: context!: React.ContextType<typeof MyContext> // For TS 3.7 and above: declare context: React.ContextType<typeof MyContext>` **See** [React Docs](https://react.dev/reference/react/Component#context) | `React.Component.context` | - |
|
|
61
|
+
| <a id="property-props"></a> `props` | `readonly` | `Readonly`\<`P`\> | - | `React.Component.props` | - |
|
|
62
|
+
| <a id="property-state"></a> `state` | `public` | `Readonly`\<`S`\> | - | `React.Component.state` | - |
|
|
63
|
+
| <a id="property-contexttype"></a> `contextType?` | `static` | `Context`\<`any`\> | If set, `this.context` will be set at runtime to the current value of the given Context. **Example** `type MyContext = number const Ctx = React.createContext<MyContext>(0) class Foo extends React.Component { static contextType = Ctx context!: React.ContextType<typeof Ctx> render () { return <>My context's value: {this.context}</>; } }` **See** [https://react.dev/reference/react/Component#static-contexttype](https://react.dev/reference/react/Component#static-contexttype) | `React.Component.contextType` | - |
|
|
64
|
+
| <a id="property-proptypes"></a> ~~`propTypes?`~~ | `static` | `any` | Ignored by React. **Deprecated** Only kept in types for backwards compatibility. Will be removed in a future major release. | `React.Component.propTypes` | - |
|
|
65
65
|
|
|
66
66
|
## Methods
|
|
67
67
|
|
|
@@ -71,7 +71,7 @@ React.Component<
|
|
|
71
71
|
componentDidCatch(error, info): void;
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
74
|
+
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L62)
|
|
75
75
|
|
|
76
76
|
Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
|
77
77
|
the entire component tree to unmount.
|
|
@@ -101,8 +101,6 @@ React.Component.componentDidCatch;
|
|
|
101
101
|
optional componentDidMount(): void;
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
Defined in: node_modules/@types/react/index.d.ts:1198
|
|
105
|
-
|
|
106
104
|
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
|
|
107
105
|
|
|
108
106
|
#### Returns
|
|
@@ -126,8 +124,6 @@ optional componentDidUpdate(
|
|
|
126
124
|
snapshot?): void;
|
|
127
125
|
```
|
|
128
126
|
|
|
129
|
-
Defined in: node_modules/@types/react/index.d.ts:1261
|
|
130
|
-
|
|
131
127
|
Called immediately after updating occurs. Not called for the initial render.
|
|
132
128
|
|
|
133
129
|
The snapshot is only present if [getSnapshotBeforeUpdate](#getsnapshotbeforeupdate) is present and returns non-null.
|
|
@@ -158,8 +154,6 @@ React.Component.componentDidUpdate;
|
|
|
158
154
|
optional componentWillMount(): void;
|
|
159
155
|
```
|
|
160
156
|
|
|
161
|
-
Defined in: node_modules/@types/react/index.d.ts:1277
|
|
162
|
-
|
|
163
157
|
Called immediately before mounting occurs, and before [Component.render](https://www.jsdocs.io/package/@types/react#Component.render).
|
|
164
158
|
Avoid introducing any side-effects or subscriptions in this method.
|
|
165
159
|
|
|
@@ -194,8 +188,6 @@ React.Component.componentWillMount;
|
|
|
194
188
|
optional componentWillReceiveProps(nextProps, nextContext): void;
|
|
195
189
|
```
|
|
196
190
|
|
|
197
|
-
Defined in: node_modules/@types/react/index.d.ts:1308
|
|
198
|
-
|
|
199
191
|
Called when the component may be receiving new props.
|
|
200
192
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
201
193
|
props if you only want to handle changes.
|
|
@@ -240,8 +232,6 @@ React.Component.componentWillReceiveProps;
|
|
|
240
232
|
optional componentWillUnmount(): void;
|
|
241
233
|
```
|
|
242
234
|
|
|
243
|
-
Defined in: node_modules/@types/react/index.d.ts:1214
|
|
244
|
-
|
|
245
235
|
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
|
246
236
|
cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`.
|
|
247
237
|
|
|
@@ -266,8 +256,6 @@ optional componentWillUpdate(
|
|
|
266
256
|
nextContext): void;
|
|
267
257
|
```
|
|
268
258
|
|
|
269
|
-
Defined in: node_modules/@types/react/index.d.ts:1340
|
|
270
|
-
|
|
271
259
|
Called immediately before rendering when new props or state is received. Not called for the initial render.
|
|
272
260
|
|
|
273
261
|
Note: You cannot call [Component.setState](#setstate) here.
|
|
@@ -311,8 +299,6 @@ React.Component.componentWillUpdate;
|
|
|
311
299
|
forceUpdate(callback?): void;
|
|
312
300
|
```
|
|
313
301
|
|
|
314
|
-
Defined in: node_modules/@types/react/index.d.ts:976
|
|
315
|
-
|
|
316
302
|
#### Parameters
|
|
317
303
|
|
|
318
304
|
| Parameter | Type |
|
|
@@ -337,8 +323,6 @@ React.Component.forceUpdate;
|
|
|
337
323
|
optional getSnapshotBeforeUpdate(prevProps, prevState): any;
|
|
338
324
|
```
|
|
339
325
|
|
|
340
|
-
Defined in: node_modules/@types/react/index.d.ts:1255
|
|
341
|
-
|
|
342
326
|
Runs before React applies the result of [render](https://www.jsdocs.io/package/@types/react#Component.render) to the document, and
|
|
343
327
|
returns an object to be given to [componentDidUpdate](#componentdidupdate). Useful for saving
|
|
344
328
|
things such as scroll position before [render](https://www.jsdocs.io/package/@types/react#Component.render) causes changes to it.
|
|
@@ -371,7 +355,7 @@ React.Component.getSnapshotBeforeUpdate;
|
|
|
371
355
|
render(): ReactNode;
|
|
372
356
|
```
|
|
373
357
|
|
|
374
|
-
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
358
|
+
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L67)
|
|
375
359
|
|
|
376
360
|
#### Returns
|
|
377
361
|
|
|
@@ -391,8 +375,6 @@ React.Component.render;
|
|
|
391
375
|
setState<K>(state, callback?): void;
|
|
392
376
|
```
|
|
393
377
|
|
|
394
|
-
Defined in: node_modules/@types/react/index.d.ts:971
|
|
395
|
-
|
|
396
378
|
#### Type Parameters
|
|
397
379
|
|
|
398
380
|
| Type Parameter |
|
|
@@ -427,8 +409,6 @@ optional shouldComponentUpdate(
|
|
|
427
409
|
nextContext): boolean;
|
|
428
410
|
```
|
|
429
411
|
|
|
430
|
-
Defined in: node_modules/@types/react/index.d.ts:1209
|
|
431
|
-
|
|
432
412
|
Called to determine whether the change in props and state should trigger a re-render.
|
|
433
413
|
|
|
434
414
|
`Component` always returns true.
|
|
@@ -464,8 +444,6 @@ React.Component.shouldComponentUpdate;
|
|
|
464
444
|
optional UNSAFE_componentWillMount(): void;
|
|
465
445
|
```
|
|
466
446
|
|
|
467
|
-
Defined in: node_modules/@types/react/index.d.ts:1292
|
|
468
|
-
|
|
469
447
|
Called immediately before mounting occurs, and before [Component.render](https://www.jsdocs.io/package/@types/react#Component.render).
|
|
470
448
|
Avoid introducing any side-effects or subscriptions in this method.
|
|
471
449
|
|
|
@@ -502,8 +480,6 @@ React.Component.UNSAFE_componentWillMount;
|
|
|
502
480
|
optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void;
|
|
503
481
|
```
|
|
504
482
|
|
|
505
|
-
Defined in: node_modules/@types/react/index.d.ts:1326
|
|
506
|
-
|
|
507
483
|
Called when the component may be receiving new props.
|
|
508
484
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
509
485
|
props if you only want to handle changes.
|
|
@@ -553,8 +529,6 @@ optional UNSAFE_componentWillUpdate(
|
|
|
553
529
|
nextContext): void;
|
|
554
530
|
```
|
|
555
531
|
|
|
556
|
-
Defined in: node_modules/@types/react/index.d.ts:1356
|
|
557
|
-
|
|
558
532
|
Called immediately before rendering when new props or state is received. Not called for the initial render.
|
|
559
533
|
|
|
560
534
|
Note: You cannot call [Component.setState](#setstate) here.
|
|
@@ -600,7 +574,7 @@ React.Component.UNSAFE_componentWillUpdate;
|
|
|
600
574
|
static getDerivedStateFromError(error): PlayErrorBoundaryState;
|
|
601
575
|
```
|
|
602
576
|
|
|
603
|
-
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
577
|
+
Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L58)
|
|
604
578
|
|
|
605
579
|
#### Parameters
|
|
606
580
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function useSignalEffect(callback): void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-react/src/useSignalEffect.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-react/src/useSignalEffect.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/useSignalEffect.ts#L65)
|
|
10
10
|
|
|
11
11
|
React hook that subscribes to signal changes and runs effect callback
|
|
12
12
|
|