liveStateDataId
(string
, required): A unique string ID to identify the dataliveStateData
(any serializable type
, required): The data to sync (objects, arrays, strings, numbers)setLiveStateDataConfig
(object
, optional): Configuration object
merge
(boolean
): Whether to merge the data with existing data (default: false
)liveStateDataId
(string
, required) - A unique string ID to identify the data to retrieveliveStateDataConfig
(object
, optional) - Configuration object for controlling data retrieval behavior
listenToNewChangesOnly
(boolean
, optional) - Whether to only receive new changes from when the client subscribed (default: false
)useLiveState()
hook provides a familiar React’s useState()
like API while automatically syncing state changes across all connected clients in real-time.
The hook accepts the following parameters:
id
(string, required): Unique identifier for syncing this state across clientsinitialValue
(any, required): Initial state valueoptions
(object, optional): Configuration object with the following properties:
syncDuration
(number, optional): Debounce delay in milliseconds before syncing. Defaults to 50ms.resetLiveState
(boolean, optional): Whether to reset server state when the hook initializes. Defaults to false.listenToNewChangesOnly
(boolean, optional): When true, only receives changes that occur after subscribing and discards historical changes. Defaults to false.[value, setValue, connectionState]
value
: Current value of the data you setsetValue
: Function to update the dataconnectionState
: Current server connection statussyncDuration
listenToNewChangesOnly
when appropriate