Function useSyncHandle

useSyncHandle<T>(ID, updateEvent?): ReactiumSyncState<T>
A React hook that consumes a handle for synchronization and triggers rerendering in the consuming component.

This hook will consume a handle registered with the given ID. It will then set up an event effect that triggers rerendering in the consuming component when the specified event is emitted. The event that triggers rerendering can be customized.
Type Parameters
- T extends object
  extends object
Parameters
- ID: Path
  The ID of the handle to consume.
- Optional updateEvent: string = 'set'
  The event that triggers rerendering in the consuming component.
Returns ReactiumSyncState<T>
The consumed handle.
See
- useHandle for how the handle is consumed.
- useEventEffect for how the event effect is set up.
- Path
- https://www.npmjs.com/package/object-path|object-path
- Defined in dev/Reactium/reactium-sdk-core/src/browser/useSyncHandle.ts:25