ws-asyncapi API / react / PresenceResult

Interface: PresenceResult<State>

Defined in: .api-entries/react/index.d.ts:37

Type Parameters

State

State

Properties

members

members: Map<string, State>

Defined in: .api-entries/react/index.d.ts:38

---

self

self: string

Defined in: .api-entries/react/index.d.ts:39

---

set

set: (state) => Promise<void>

Defined in: .api-entries/react/index.d.ts:40

Parameters

state

State

Returns

Promise<void>

---

update

update: (patch) => void

Defined in: .api-entries/react/index.d.ts:42

volatile, fire-and-forget update (cursor hot path) — see presence.update

Parameters

patch

Partial<State>

Returns

void

---

clear

clear: () => Promise<void>

Defined in: .api-entries/react/index.d.ts:43

Returns

Promise<void>