Class AwarenessWasm<T>

Awareness is a structure that tracks the ephemeral state of peers.

It can be used to synchronize cursor positions, selections, and the names of the peers.

The state of a specific peer is expected to be removed after a specified timeout. Use remove_outdated to eliminate outdated states.

Type Parameters

Constructors

constructor

Methods

apply encode encodeAll free getAllStates getState getTimestamp isEmpty length peer peers removeOutdated setLocalState

Constructors

constructor

  • new AwarenessWasm<T extends Value = Value>(
        peer: number | bigint | `${number}`,
        timeout: number,
    ): AwarenessWasm<T>

    Creates a new Awareness instance.

    The timeout parameter specifies the duration in milliseconds. A state of a peer is considered outdated, if the last update of the state of the peer is older than the timeout.

    Type Parameters

    Parameters

    • peer: number | bigint | `${number}`
    • timeout: number

    Returns AwarenessWasm<T>

Methods

apply

  • apply(
        encoded_peers_info: Uint8Array,
    ): { added: `${number}`[]; updated: `${number}`[] }

    Applies the encoded state of peers.

    Each peer's deletion countdown will be reset upon update, requiring them to pass through the timeout interval again before being eligible for deletion.

    Parameters

    • encoded_peers_info: Uint8Array

    Returns { added: `${number}`[]; updated: `${number}`[] }

encode

  • encode(peers: any[]): Uint8Array

    Encodes the state of the given peers.

    Parameters

    • peers: any[]

    Returns Uint8Array

encodeAll

  • encodeAll(): Uint8Array

    Encodes the state of all peers.

    Returns Uint8Array

free

  • free(): void

    Returns void

getAllStates

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

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

getState

  • getState(peer: `${number}`): T

    Parameters

    • peer: `${number}`

    Returns T

getTimestamp

  • getTimestamp(peer: `${number}`): number

    Parameters

    • peer: `${number}`

    Returns number

  • getTimestamp(peer: number | bigint | `${number}`): number

    Get the timestamp of the state of a given peer.

    Parameters

    • peer: number | bigint | `${number}`

    Returns number

isEmpty

  • isEmpty(): boolean

    If the state is empty.

    Returns boolean

length

  • length(): number

    Get the number of peers.

    Returns number

peer

  • peer(): `${number}`

    Get the PeerID of the local peer.

    Returns `${number}`

peers

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

    Get all the peers

    Returns `${number}`[]

removeOutdated

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

    Returns `${number}`[]

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

    Remove the states of outdated peers.

    Returns `${number}`[]

setLocalState

  • setLocalState(value: T): void

    Parameters

    • value: T

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods