IFClite TypeScript API
    Preparing search index...
    interface WebSocketProviderOptions {
        awareness?: Awareness;
        connect?: boolean;
        disableBc?: boolean;
        params?: Record<string, string>;
        token?: string;
        WebSocketPolyfill?: unknown;
    }
    Index
    awareness?: Awareness

    Awareness instance to share over the same transport.

    connect?: boolean

    Disable connect on construction; call connect() explicitly.

    disableBc?: boolean

    Disable the BroadcastChannel intra-browser shortcut. When two tabs open the same room in the same browser, y-websocket normally syncs them via BroadcastChannel and never round-trips through the server. Set true to force every edit through the websocket — useful for demos / debugging server-side flows.

    params?: Record<string, string>

    Extra params appended to the connect URL.

    token?: string

    Bearer token attached as ?token= for the server to validate.

    WebSocketPolyfill?: unknown

    Custom WebSocket implementation (e.g. ws in Node tests).