Class VersionVector

VersionVector is a map from [PeerID] to [Counter]. Its a right-open interval.

i.e. a [VersionVector] of {A: 1, B: 2} means that A has 1 atomic op and B has 2 atomic ops, thus ID of {client: A, counter: 1} is out of the range.

Constructors

constructor

Methods

compare encode free get length remove setEnd setLast toJSON decode parseJSON

Constructors

constructor

  • new VersionVector(
        value:
            | Uint8Array<ArrayBufferLike>
            | VersionVector
            | Map<`${number}`, number>,
    ): VersionVector

    Create a new version vector.

    Parameters

    • value: Uint8Array<ArrayBufferLike> | VersionVector | Map<`${number}`, number>

    Returns VersionVector

Methods

compare

  • compare(other: VersionVector): number

    Compare the version vector with another version vector.

    If they are concurrent, return undefined.

    Parameters

    Returns number

encode

  • encode(): Uint8Array

    Encode the version vector into a Uint8Array.

    Returns Uint8Array

free

  • free(): void

    Returns void

get

  • get(peer_id: number | bigint | `${number}`): number

    Get the counter of a peer.

    Parameters

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

    Returns number

length

  • length(): number

    Returns number

remove

  • remove(peer: `${number}`): void

    Parameters

    • peer: `${number}`

    Returns void

setEnd

  • setEnd(id: { counter: number; peer: `${number}` }): void

    set the exclusive ending point. target id will NOT be included by self

    Parameters

    • id: { counter: number; peer: `${number}` }

    Returns void

setLast

  • setLast(id: { counter: number; peer: `${number}` }): void

    set the inclusive ending point. target id will be included

    Parameters

    • id: { counter: number; peer: `${number}` }

    Returns void

toJSON

  • toJSON(): Map<`${number}`, number>

    Convert the version vector to a Map

    Returns Map<`${number}`, number>

Staticdecode

  • decode(bytes: Uint8Array): VersionVector

    Decode the version vector from a Uint8Array.

    Parameters

    • bytes: Uint8Array

    Returns VersionVector

StaticparseJSON

  • parseJSON(version: Map<`${number}`, number>): VersionVector

    Create a new version vector from a Map.

    Parameters

    • version: Map<`${number}`, number>

    Returns VersionVector

Settings

Member Visibility

On This Page

Constructors
Methods