@dxos/client
    Preparing search index...

    Type Alias CreateClientServicesOptions

    type CreateClientServicesOptions = {
        createCoordinatorWorker?: () => SharedWorker;
        createDedicatedWorker?: DedeciatedWorkerClientServicesOptions["createWorker"];
        createOpfsWorker?: LocalClientServicesParams["createOpfsWorker"];
        createWorker?: WorkerClientServicesProps["createWorker"];
        observabilityGroup?: string;
        signalTelemetryEnabled?: boolean;
        singleClientMode?: boolean;
        sqlitePath?: LocalClientServicesParams["sqlitePath"];
    }
    Index

    Properties

    createCoordinatorWorker? createDedicatedWorker? createOpfsWorker? createWorker? observabilityGroup? signalTelemetryEnabled? singleClientMode? sqlitePath?

    Properties

    createCoordinatorWorker?: () => SharedWorker

    Factory for creating the coordinator SharedWorker (for dedicated worker mode). Use for a custom entrypoint that e.g. initializes observability.

    createDedicatedWorker?: DedeciatedWorkerClientServicesOptions["createWorker"]

    Factory for creating a dedicated worker.

    createOpfsWorker?: LocalClientServicesParams["createOpfsWorker"]

    Factory for creating an OPFS worker.

    createWorker?: WorkerClientServicesProps["createWorker"]

    Factory for creating a shared worker.

    observabilityGroup?: string

    Observability group sent with signaling metadata.

    signalTelemetryEnabled?: boolean

    Enable telemetry metadata sent with signaling requests.

    singleClientMode?: boolean

    Use single-client mode for the dedicated worker coordinator. This bypasses SharedWorker which doesn't work on iOS WKWebView.

    sqlitePath?: LocalClientServicesParams["sqlitePath"]

    Path to SQLite database file for persistent indexing in Node/Bun.

    Settings

    Member Visibility

    On This Page

    Properties