• Preparing search index...
  • The search index is not available
Automerge Repo - v2.0.0-alpha.20
  • Automerge Repo
  • @automerge/automerge-repo-react-hooks
  • useRemoteAwareness

Function useRemoteAwareness

  • useRemoteAwareness<T>(__namedParameters): [PeerStates, Heartbeats]
  • This hook returns read-only state for remote clients. It also returns their heartbeat status. It is intended to be used alongside useLocalAwareness.

    Type Parameters

    • T

    Parameters

    • __namedParameters: UseRemoteAwarenessProps<T>

    Returns [PeerStates, Heartbeats]

    [ peerStates: { [userId]: state, ... }, { [userId]: heartbeatEpochTime, ...} ]

    • Defined in useRemoteAwareness.ts:40

Settings

Member Visibility

Theme

Automerge Repo - v2.0.0-alpha.20
  • Loading...

Generated using TypeDoc