@yoltra/devtools-protocol
36 exports
Classes
ReconnectingWsClientReconnecting WebSocket client that connects a Yoltra store to the DevTools hub.
Functions
Interfaces
BaseMessageBase structure shared by all DevTools protocol messages.DevtoolsSocketCallbacksLifecycle callbacks the transport wires to the underlying socket.DevtoolsSocketHandleMinimal socket handle the shared client operates on.EmitToStoreEmit an event to a store from an extension.EventReplayReplay events from a snapshot through reducers only.ExtensionCapabilitiesCapabilities advertised by an extension during handshake.HandshakeRequestSent by a client immediately after WebSocket connection.HandshakeResponseHub response to a HandshakeRequest.HubCapabilitiesCapabilities advertised by the hub during handshake response.JsonPatchA single JSON Patch operation per RFC 6902.ReconnectingWsConfigReconnection/buffering configuration.RequestMetricsRequest performance metrics from a store.RequestStateRequest a full state snapshot from a store.RequestSubscriptionsRequest subscription and consumer info from a store.SamplingConfigSampling configuration for event throttling/filtering.StateSnapshotFull state snapshot, sent in response to RequestState.StoreCapabilitiesCapabilities advertised by a store during handshake.StoreConnectedBroadcast when a store connects to the hub.StoreDisconnectedBroadcast when a store disconnects from the hub.StoreEventAn event emitted by a store, forwarded to extensions.StoreMetricsStore performance metrics.StoreRegistryRegistry of all connected stores, sent to extensions on connect and whenever the registry changes.StoreSubscriptionsStore subscription and consumer info.TimeTravelTime travel: jump a store to a specific state.
Type Aliases
ConnectionStateConnection state for the devtools WS client.DevtoolsMessageUnion of all DevTools protocol messages.DevtoolsSocketFactoryOpens a socket to `url`, wiring the given callbacks, and returns a handle.JsonPatchOpJSON Patch operation types per [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902).
Variables
PROTOCOL_VERSIONProtocol version following semver.WS_CONNECTINGWebSocket `readyState` for a connecting socket (per the WebSocket standard).WS_OPENWebSocket `readyState` for an open socket (per the WebSocket standard).