Collaborator

Defined in: collab.ts:155

Makes a single editor a live collaborator on a shared document.

Typical usage:

const net = createMemoryNetwork({ origin: baseDoc });
const me = new Collaborator({ peer: { id: 'alice' }, editor, transport: net.connect() });
me.onChange((s) => render(s));            // react to confirmed/pending changes
me.setPresence({ status: 'editing' });    // broadcast awareness
// ...local edits flow automatically via the editor's transactions.

Constructors

Constructor

new Collaborator(options): Collaborator;

Defined in: collab.ts:178

Parameters

Parameter	Type
options	CollaboratorOptions

Returns

Collaborator

Properties

Property	Modifier	Type	Description	Defined in
ledger	readonly	TransactionLedger	The confirmed (canonical) log this client has applied — the shared source of truth, for diff/serialize.	collab.ts:159
peer	readonly	Peer	-	collab.ts:156
presence	readonly	PresenceTracker	-	collab.ts:157

Accessors

confirmedDocument

Get Signature

get confirmedDocument(): DocumentNode;

Defined in: collab.ts:224

The confirmed/canonical document (excludes un-acked local edits).

Returns

DocumentNode

---

document

Get Signature

get document(): DocumentNode;

Defined in: collab.ts:219

The optimistic document currently shown in the editor (confirmed + pending).

Returns

DocumentNode

---

peers

Get Signature

get peers(): PeerPresence[];

Defined in: collab.ts:229

Other peers’ presence (what you render as remote cursors).

Returns

PeerPresence[]

---

status

Get Signature

get status(): CollabStatus;

Defined in: collab.ts:214

Returns

CollabStatus

Methods

destroy()

destroy(): void;

Defined in: collab.ts:263

Detach from the editor and transport, announcing departure.

Returns

void

---

onChange()

onChange(listener): () => void;

Defined in: collab.ts:238

Parameters

Parameter	Type
listener	CollabChangeListener

Returns

() => void

---

patchPresence()

patchPresence(patch): void;

Defined in: collab.ts:252

Merge a partial patch into this client’s awareness state and broadcast it.

Parameters

Parameter	Type
patch	Partial<PresenceState>

Returns

void

---

setPresence()

setPresence(state): void;

Defined in: collab.ts:246

Replace this client’s awareness state and broadcast it.

Parameters

Parameter	Type
state	PresenceState

Returns

void

---

start()

start(): void;

Defined in: collab.ts:197

Begin the handshake (send hello). Called automatically unless autoStart: false.

Returns

void

---

sync()

sync(): void;

Defined in: collab.ts:258

Request any canonical records this client is missing (late join / reconnect).

Returns

void

---

versionVector()

versionVector(): VersionVector;

Defined in: collab.ts:234

This client’s view vector — the highest seq seen per source.

Returns

VersionVector