Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReplicatedRegisterMap<Key, Value>

A replicated map of registers.

Type Parameters

Hierarchy

  • ReplicatedRegisterMap

Implements

Index

Constructors

Methods

Accessors

Constructors

constructor

Methods

get

  • get(key: Key): undefined | Value

  • Get the value at the given key.

    Parameters

    • key: Key

      The key to get

    Returns undefined | Value

    The register value, or undefined if no value is defined at that key

set

  • Set the register at the given key to the given value.

    Parameters

    • key: Key

      The key for the register

    • value: Value

      The new value for the register

    • clock: Clocks = Clocks.DEFAULT

      The register clock, otherwise default clock

    • customClockValue: number | Long = 0

      Clock value when using custom clock, otherwise ignored

    Returns ReplicatedRegisterMap<Key, Value>

    This register map

has

  • has(key: Key): boolean

  • Check whether this map contains a value of the given key.

    Parameters

    • key: Key

      The key to check

    Returns boolean

    True if this register map contains a value for the given key

keys

  • keys(): IterableIterator<Key>

delete

clear

toString

  • toString(): string

Accessors

size

  • get size(): number

Generated using TypeDoc