IFClite TypeScript API
    Preparing search index...

    Interface CollabSessionOptions

    interface CollabSessionOptions {
        connect?: boolean;
        dbName?: string;
        disableBc?: boolean;
        doc?: Doc;
        presence?: { staleAfterMs?: number; updateRateHz?: number };
        presenceInstance?: Presence;
        provider?: ProviderKind;
        roomId: string;
        serverUrl?: string;
        token?: string;
        user: UserIdentity;
        WebSocketPolyfill?: unknown;
    }
    Index
    connect? dbName? disableBc? doc? presence? presenceInstance? provider? roomId serverUrl? token? user WebSocketPolyfill?
    connect?: boolean

    Auto-connect the websocket on construction (default true).

    dbName?: string

    Override the IDB database name.

    disableBc?: boolean

    Disable BroadcastChannel intra-browser sync — every edit goes through the websocket. Forwarded to the websocket provider; ignored for memory / indexeddb-only sessions. Default false.

    doc?: Doc

    Existing Y.Doc to bind to. Defaults to a fresh createCollabDoc().

    presence?: { staleAfterMs?: number; updateRateHz?: number }

    Presence config knobs.

    presenceInstance?: Presence

    Bind to an existing Presence (e.g. a shared federation presence) instead of creating one. When supplied, this session does NOT own the instance and will not dispose it — the caller remains responsible for its lifecycle.

    provider?: ProviderKind

    Choice of network/persistence stack. 'indexeddb+websocket' runs both (recommended for browser deployments). 'memory' is for tests and ephemeral rooms.

    roomId: string
    serverUrl?: string

    Required when provider involves websocket.

    token?: string

    Bearer token forwarded to the websocket server.

    user: UserIdentity
    WebSocketPolyfill?: unknown

    Ws polyfill (e.g. ws package in Node tests).

    Settings
    Member Visibility

    On This Page
    Properties