Class LoroCounter

constructor

• new LoroCounter(): LoroCounter

  Create a new LoroCounter.

  Returns LoroCounter

Readonlyid

Readonlyvalue

decrement

• decrement(value: number): void

  Decrement the counter by the given value.

  Parameters

  • value: number

  Returns void

free

• free(): void

  Returns void

getAttached

• getAttached(): LoroTree<Record<string, unknown>>

  Get the attached container associated with this.

  Returns an attached Container that equals to this or created by this, otherwise undefined.

  Returns LoroTree<Record<string, unknown>>

getShallowValue

• getShallowValue(): number

  Get the value of the counter.

  Returns number

increment

• increment(value: number): void

  Increment the counter by the given value.

  Parameters

  • value: number

  Returns void

isAttached

• isAttached(): boolean

  Whether the container is attached to a docuemnt.

  If it's detached, the operations on the container will not be persisted.

  Returns boolean

kind

• kind(): "Counter"

  "Counter"

  Returns "Counter"

parent

• parent(): Container

  Get the parent container of the counter container.

  • The parent container of the root counter is undefined.
  • The object returned is a new js object each time because it need to cross the WASM boundary.

  Returns Container

subscribe

• subscribe(f: Function): any

  Subscribe to the changes of the counter.

  Parameters

  • f: Function

  Returns any