Interface: AwarenessStore

@roomful/svelte

---

@roomful/svelte / AwarenessStore

Interface: AwarenessStore

Defined in: packages/svelte/src/index.ts:234

Readable awareness store augmented with write helpers.

Extends

• Readable<AwarenessStoreValue>

Methods

set()

set(value): void

Defined in: packages/svelte/src/index.ts:241

Merges arbitrary awareness metadata into the local peer.

Parameters

value

Record<string, unknown>

The awareness fields to merge.

Returns

void

Nothing.

---

setFocus()

setFocus(elementId): void

Defined in: packages/svelte/src/index.ts:249

Updates the local focus target.

Parameters

elementId

The focused element identifier, or null to clear it.

string | null

Returns

void

Nothing.

---

setSelection()

setSelection(selection): void

Defined in: packages/svelte/src/index.ts:257

Updates the local selection.

Parameters

selection

The active selection, or null to clear it.

AwarenessSelection | null

Returns

void

Nothing.

---

setTyping()

setTyping(isTyping): void

Defined in: packages/svelte/src/index.ts:265

Updates the local typing state.

Parameters

isTyping

boolean

Whether the local peer is currently typing.

Returns

void

Nothing.

---

subscribe()

subscribe(this, run, invalidate?): Unsubscriber

Defined in: node_modules/.pnpm/svelte@4.2.20/node_modules/svelte/types/index.d.ts:1619

Subscribe on value changes.

Parameters

this

void

run

Subscriber<AwarenessStoreValue>

subscription callback

invalidate?

Invalidator<AwarenessStoreValue>

cleanup callback

Returns

Unsubscriber

Inherited from

Readable.subscribe

---

update()

update(updater): void

Defined in: packages/svelte/src/index.ts:273

Updates awareness fields from the previous value.

Parameters

updater

Updater<Record<string, unknown>>

The updater that returns the next awareness patch.

Returns

void

Nothing.