Interface: UsePresenceResult\<TPresence\>

@roomful/solid

---

@roomful/solid / UsePresenceResult

Interface: UsePresenceResult<TPresence>

Defined in: solid/src/index.ts:125

Describes the return value of usePresence.

Type Parameters

TPresence

TPresence extends PresenceData = PresenceData

The room presence shape.

Properties

all

all: Accessor<Peer<TPresence>[]>

Defined in: solid/src/index.ts:139

Exposes local and remote peers.

---

others

others: Accessor<Peer<TPresence>[]>

Defined in: solid/src/index.ts:134

Exposes remote peers only.

---

replace()

replace: (this, data) => void

Defined in: solid/src/index.ts:149

Replaces the local presence payload.

Replaces the local presence payload. Overwrites the existing value.

Parameters

this

void

data

Partial<TPresence>

The partial presence payload to publish for the local peer.

Returns

void

Nothing.

---

self

self: Accessor<Peer<TPresence>>

Defined in: solid/src/index.ts:129

Exposes the local peer snapshot.

---

update()

update: (this, data) => void

Defined in: solid/src/index.ts:144

Partially updates the local presence payload.

Partially updates the local presence payload. Merges into the existing value.

Parameters

this

void

data

Partial<TPresence>

The partial presence payload to merge into the local peer.

Returns

void

Nothing.