Class PeerStateView<State>

Type Parameters

State extends PresenceState

Index

Constructors

Properties

Accessors

devices peers users

Methods

getDevicePeers getDeviceState getLastActivePeer getLastSeenPeer getUserPeers getUserState

Constructors

constructor

new PeerStateView<State extends PresenceState>(
value: PeerStatesValue<State>,
): PeerStateView<State>
Type Parameters
- State extends PresenceState
Parameters
- value: PeerStatesValue<State>
Returns PeerStateView<State>
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:8

Properties

`Readonly`value

value: PeerStatesValue<State>

Accessors

devices

get devices(): (undefined | PeerState<State>)[]
Get all devices.

Returns (undefined | PeerState<State>)[]
Array of device presence States
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:29

peers

get peers(): PeerState<State>[]
Get all peers.

Returns PeerState<State>[]
Array of peer presence States
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:41

users

get users(): (undefined | PeerState<State>)[]
Get all users.

Returns (undefined | PeerState<State>)[]
Array of user presence States
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:17

Methods

getDevicePeers

getDevicePeers(deviceId: unknown): PeerId[]
Get all peers for this device.
Parameters
- deviceId: unknown
Returns PeerId[]
Array of peer ids for this device
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:63

getDeviceState

getDeviceState(deviceId: unknown): undefined | PeerState<State>
Get current ephemeral state value for this device's most-recently-active peer.
Parameters
- deviceId: unknown
Returns undefined | PeerState<State>
device's State
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:142

getLastActivePeer

getLastActivePeer(peers: PeerId[]): undefined | PeerId
Return the peer from this group that sent a state update most recently
Parameters
- peers: PeerId[]
Returns undefined | PeerId
id of most recently seen peer
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:98

getLastSeenPeer

getLastSeenPeer(peers: PeerId[]): undefined | PeerId
Return the most-recently-seen peer from this group.
Parameters
- peers: PeerId[]
Returns undefined | PeerId
id of most recently seen peer
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:75

getUserPeers

getUserPeers(userId: unknown): PeerId[]
Get all peer ids for this user.
Parameters
- userId: unknown
Returns PeerId[]
Array of peer ids for this user
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:51

getUserState

getUserState(userId: unknown): undefined | PeerState<State>
Get current ephemeral state value for this user's most-recently-active peer.
Parameters
- userId: unknown
Returns undefined | PeerState<State>
user's State
- Defined in packages/automerge-repo/src/presence/PeerStateView.ts:122