Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a mutable CRDT register that can be set to a specific value when updating a document.

This class can't be instantiated directly, it's returned automatically for any register property of a document within an update block via MutableDocumentPath.register.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

Accessors

  • get value(): any
  • set value(value: any): void
  • Returns the value of the register.

    Returns any

  • Sets the register to the provided value. Only valid within the closure of Collection's {@link Collection.update | update()} method, otherwise an exception is thrown.

    Parameters

    • value: any

    Returns void

Methods

  • set(value: any): void
  • Parameters

    • value: any

    Returns void