Class AwarenessAdapter

Adapter that wraps Loro's EphemeralStore to provide awareness functionality. Tracks user presence, cursor positions, and selection states.

Implements

AwarenessProvider

Index

Constructors

Properties

_doc clientId ephemeralStore localState updateListeners

Methods

decodeRemoteState dispose encodeLocalState getLocalState getStates notifyListeners off on setLocalState setLocalStateField updateEphemeralStore

Constructors

constructor

new AwarenessAdapter(
    doc: LoroDoc,
    userName: string,
    userColor: string,
    ephemeralStore?: EphemeralStore<Record<string, Value>>,
): AwarenessAdapter
Parameters
- doc: LoroDoc
- userName: string
- userColor: string
- OptionalephemeralStore: EphemeralStore<Record<string, Value>>
Returns AwarenessAdapter
- Defined in renderer/services/loro/awarenessAdapter.ts:32

Properties

`Private` `Readonly`_doc

_doc: LoroDoc

Loro document reference - stored for potential future use

`Private` `Readonly`clientId

clientId: number

`Private` `Readonly`ephemeralStore

ephemeralStore: EphemeralStore

`Private`localState

localState: UserState | null = null

`Private`updateListeners

updateListeners: Set<() => void> = ...

Methods

decodeRemoteState

decodeRemoteState(bytes: Uint8Array): void
Decode and apply remote ephemeral state from bytes (uses Loro's native decoding)
Parameters
- bytes: Uint8Array
Returns void
- Defined in renderer/services/loro/awarenessAdapter.ts:161

dispose

dispose(): void
Clean up resources

Returns void
- Defined in renderer/services/loro/awarenessAdapter.ts:176

encodeLocalState

encodeLocalState(): Uint8Array
Encode all ephemeral state to bytes for transmission (uses Loro's native encoding)

Returns Uint8Array
- Defined in renderer/services/loro/awarenessAdapter.ts:146

getLocalState

getLocalState(): UserState | null
Get the local user's awareness state

Returns UserState | null
Implementation of AwarenessProvider.getLocalState
- Defined in renderer/services/loro/awarenessAdapter.ts:66

getStates

getStates(): Map<number, UserState>
Get all awareness states from all users

Returns Map<number, UserState>
Implementation of AwarenessProvider.getStates
- Defined in renderer/services/loro/awarenessAdapter.ts:73

`Private`notifyListeners

notifyListeners(): void
Notify all update listeners

Returns void
- Defined in renderer/services/loro/awarenessAdapter.ts:204

off

off(type: "update", cb: () => void): void
Unregister update listener
Parameters
- type: "update"
- cb: () => void
Returns void
Implementation of AwarenessProvider.off
- Defined in renderer/services/loro/awarenessAdapter.ts:137

on

on(type: "update", cb: () => void): void
Register update listener
Parameters
- type: "update"
- cb: () => void
Returns void
Implementation of AwarenessProvider.on
- Defined in renderer/services/loro/awarenessAdapter.ts:128

setLocalState

setLocalState(state: UserState): void
Set the entire local state
Parameters
- state: UserState
Returns void
Implementation of AwarenessProvider.setLocalState
- Defined in renderer/services/loro/awarenessAdapter.ts:102

setLocalStateField

setLocalStateField(field: string, value: unknown): void
Update a specific field in the local state
Parameters
- field: string
- value: unknown
Returns void
Implementation of AwarenessProvider.setLocalStateField
- Defined in renderer/services/loro/awarenessAdapter.ts:111

`Private`updateEphemeralStore

updateEphemeralStore(): void
Update the ephemeral store with current local state

Returns void
- Defined in renderer/services/loro/awarenessAdapter.ts:184