BlockSuite API Documentation / @blocksuite/store / AwarenessStore

Class: AwarenessStore

Defined in: packages/framework/store/src/yjs/awareness.ts:22

Constructors

new AwarenessStore()

new AwarenessStore(awareness): AwarenessStore

Defined in: packages/framework/store/src/yjs/awareness.ts:25

Parameters

awareness

Awareness

Returns

AwarenessStore

Properties

awareness

readonly awareness: Awareness

Defined in: packages/framework/store/src/yjs/awareness.ts:23

Methods

destroy()

destroy(): void

Defined in: packages/framework/store/src/yjs/awareness.ts:30

Returns

void

---

getLocalSelection()

getLocalSelection(selectionManagerId): readonly Record<string, unknown>[]

Defined in: packages/framework/store/src/yjs/awareness.ts:34

Parameters

selectionManagerId

string

Returns

readonly Record<string, unknown>[]

---

getLocalState()

getLocalState(): RawAwarenessState

Defined in: packages/framework/store/src/yjs/awareness.ts:47

Returns

RawAwarenessState

---

getStates()

getStates(): Map<number, RawAwarenessState>

Defined in: packages/framework/store/src/yjs/awareness.ts:43

Returns

Map<number, RawAwarenessState>

---

setLocalSelection()

setLocalSelection(selectionManagerId, selection): void

Defined in: packages/framework/store/src/yjs/awareness.ts:62

Parameters

selectionManagerId

string

selection

UserSelection

Returns

void

---

setLocalState()

setLocalState(state): void

Defined in: packages/framework/store/src/yjs/awareness.ts:51

Parameters

state

RawAwarenessState

Returns

void

---

setLocalStateField()

setLocalStateField<Field>(field, value): void

Defined in: packages/framework/store/src/yjs/awareness.ts:55

Type Parameters

Field

Field extends keyof RawAwarenessState

Parameters

field

Field

value

RawAwarenessState[Field]

Returns

void