Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VarEventsRecord<T>

Base events record for an IVar<T> implementation.

Type Parameters

  • T

Hierarchy

Index

Properties

Properties

Emitted right after any other event is emitted.

Listen on this if you want to know each time the Collab emits an event (e.g., so you can refresh a display based on its state) without having to listen on each individual event type.

When using CRuntime, note that this event may be emitted multiple times in the middle of a transaction. You typically want to wait to refresh displays until the next DocEventsRecord.Change event, e.g.:

let isDirty = false;
collab.on("Any", () => { isDirty = true; });
doc.on("Change", () => {
if (isDirty) {
refreshDisplay();
isDirty = false;
}
})

Or, in a React component, use @collabs/react's useCollab.

Set: VarEvent<T>

Emitted whenever the value is set or otherwise changed.

Generated using TypeDoc