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

Constructors

constructor

Properties

inner

Methods

addListener apply destroy encode encodeAll getAllStates getLocalState peers removeListener setLocalState

Constructors

constructor

  • new Awareness<T extends Value = Value>(
        peer: `${number}`,
        timeout?: number,
    ): Awareness<T>

    Type Parameters

    Parameters

    • peer: `${number}`
    • Optionaltimeout: number

    Returns Awareness<T>

Properties

inner

inner: AwarenessWasm<T>

Methods

addListener

  • addListener(listener: AwarenessListener): void

    Parameters

    Returns void

apply

  • apply(bytes: Uint8Array, origin?: string): void

    Parameters

    • bytes: Uint8Array
    • Optionalorigin: string

    Returns void

destroy

  • destroy(): void

    Returns void

encode

  • encode(peers: `${number}`[]): Uint8Array

    Parameters

    • peers: `${number}`[]

    Returns Uint8Array

encodeAll

  • encodeAll(): Uint8Array

    Returns Uint8Array

getAllStates

  • getAllStates(): Record<`${number}`, T>

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

getLocalState

  • getLocalState(): T

    Returns T

peers

  • peers(): `${number}`[]

    Returns `${number}`[]

removeListener

  • removeListener(listener: AwarenessListener): void

    Parameters

    Returns void

setLocalState

  • setLocalState(state: T): void

    Parameters

    • state: T

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods