CollaborationPluginOptions

Properties

manualClock?

readonly optional manualClock?: boolean

A simulation can drive session.tick itself; browser attachments run a bounded interval.

---

mergeReview?

readonly optional mergeReview?: MergeReviewOptions

---

onReady?

readonly optional onReady?: (connection) => void | (() => void)

Parameters

connection

CollaborationConnection

Returns

void | (() => void)

---

presence?

readonly optional presence?: object

colour

readonly colour: string

displayName

readonly displayName: string

---

session

readonly session: CollaborationDocumentOptions & object

Type Declaration

room

readonly room: string

---

timing?

readonly optional timing?: Partial<Pick<SessionOptions<Envelope>, "pulseInterval" | "suspicionTimeout" | "dependencyTimeout" | "historyChunkRecords">>

---

transport

readonly transport: object

send

readonly send: (peer, message) => void

Parameters

peer

string

message

Message<Envelope>

Returns

void