Class Awareness<T>

Awareness is a structure that allows to track the ephemeral state of the peers.

If we don't receive a state update from a peer within the timeout, we will remove their state. The timeout is in milliseconds. This can be used to handle the off-line state of a peer.

Type Parameters

T extends Value = Value

Index

Methods

addListener

addListener(listener: AwarenessListener): void
Parameters
- listener: AwarenessListener
Returns void
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:67

apply

apply(bytes: Uint8Array, origin?: string): void
Parameters
- bytes: Uint8Array
- Optionalorigin: string
Returns void
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:61

destroy

destroy(): void
Returns void
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:70

encode

encode(peers: `${number}`[]): Uint8Array
Parameters
- peers: `${number}`[]
Returns Uint8Array
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:65

encodeAll

encodeAll(): Uint8Array
Returns Uint8Array
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:66

getAllStates

getAllStates(): Record<`${number}`, T>
Returns Record<`${number}`, T>
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:64

getLocalState

getLocalState(): undefined | T
Returns undefined | T
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:63

peers

peers(): `${number}`[]
Returns `${number}`[]
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:69

removeListener

removeListener(listener: AwarenessListener): void
Parameters
- listener: AwarenessListener
Returns void
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:68

setLocalState

setLocalState(state: T): void
Parameters
- state: T
Returns void
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:62

Constructors

constructor

new Awareness<T extends Value = Value>(
peer: `${number}`,
timeout?: number,
): Awareness<T>
Type Parameters
- T extends Value = Value
Parameters
- peer: `${number}`
- Optionaltimeout: number
Returns Awareness<T>
- Defined in node_modules/.deno/loro-crdt@1.4.6/node_modules/loro-crdt/bundler/index.d.ts:60

Properties

inner

inner: AwarenessWasm<T>

Class Awareness<T>

Type Parameters

Index

Methods

Constructors

Properties

Methods

addListener

Parameters

Returns void

apply

Parameters

Returns void

destroy

Returns void

encode

Parameters

Returns Uint8Array

encodeAll

Returns Uint8Array

getAllStates

Returns Record<`${number}`, T>

getLocalState

Returns undefined | T

peers

Returns `${number}`[]

removeListener

Parameters

Returns void

setLocalState

Parameters

Returns void

Constructors

constructor

Type Parameters

Parameters

Returns Awareness<T>

Properties

inner

Settings

On This Page