Interface CollabSession

interface CollabSession {
    clientId: number;
    conflicts: ConflictDetector;
    doc: Doc;
    presence: Presence;
    provider: ProviderKind;
    roomId: string;
    undoController: UndoController;
    whenSynced: Promise<void>;
    captureBaseline(): Uint8Array;
    captureDocState(): Uint8Array;
    dispose(): void;
    extractUserLayer(
        baseline: Uint8Array,
        clientId?: number,
        snapshot?: SnapshotOptions,
    ): IfcxFile;
    onConflict(listener: ConflictListener): () => void;
    onStatus(
        listener: (s: WebSocketStatus | "memory" | "indexeddb") => void,
    ): () => void;
    redo(): boolean;
    seed(input: IfcxInput, options?: SeedOptions): IfcxFile;
    snapshot(options?: SnapshotOptions): IfcxFile;
    status(): WebSocketStatus | "memory" | "indexeddb";
    transact<T>(fn: () => T): T;
    undo(): boolean;
}

Index

Properties

`Readonly`clientId

clientId: number

`Readonly`conflicts

conflicts: ConflictDetector

`Readonly`doc

doc: Doc

`Readonly`presence

presence: Presence

`Readonly`provider

provider: ProviderKind

`Readonly`roomId

roomId: string

`Readonly`undoController

undoController: UndoController

`Readonly`whenSynced

whenSynced: Promise<void>

Resolves once both persistence and (if applicable) websocket sync have completed.

Methods

captureBaseline

captureBaseline(): Uint8Array

Capture a baseline state vector for later layer extraction.

Returns Uint8Array

captureDocState

captureDocState(): Uint8Array

Capture the doc's FULL state (Y.encodeStateAsUpdate) as the fork point for whole-doc publishing (publishLayer's baseline). Distinct from captureBaseline, which returns a state VECTOR for the per-user extractUserLayer path.

Returns Uint8Array

dispose

dispose(): void

Returns void

extractUserLayer

extractUserLayer(
    baseline: Uint8Array,
    clientId?: number,
    snapshot?: SnapshotOptions,
): IfcxFile
Extract a per-user layer (defaults to this peer).
Parameters
- baseline: Uint8Array
- OptionalclientId: number
- Optionalsnapshot: SnapshotOptions
Returns IfcxFile

onConflict

onConflict(listener: ConflictListener): () => void
Parameters
- listener: ConflictListener
Returns () => void

onStatus

onStatus(
listener: (s: WebSocketStatus | "memory" | "indexeddb") => void,
): () => void
Parameters
- listener: (s: WebSocketStatus | "memory" | "indexeddb") => void
Returns () => void

redo

redo(): boolean

Returns boolean

seed

seed(input: IfcxInput, options?: SeedOptions): IfcxFile
Seed this session's Y.Doc from an IFCX file.
Parameters
- input: IfcxInput
- Optionaloptions: SeedOptions
Returns IfcxFile

snapshot

snapshot(options?: SnapshotOptions): IfcxFile
Snapshot the current state to an IFCX object.
Parameters
- Optionaloptions: SnapshotOptions
Returns IfcxFile

status

status(): WebSocketStatus | "memory" | "indexeddb"

Returns WebSocketStatus | "memory" | "indexeddb"

transact

transact<T>(fn: () => T): T
Wrap edits in a Yjs transaction tagged with our local origin.
Type Parameters
- T
Parameters
- fn: () => T
Returns T

undo

undo(): boolean

Local-origin undo via Y.UndoManager.

Returns boolean