@dxos/client
    Preparing search index...

    Type Alias ClientOptions

    This options object configures the DXOS Client.

    type ClientOptions = {
        config?: Config;
        createOpfsWorker?: () => Worker;
        createWorker?: () => SharedWorker;
        services?: MaybePromise<ClientServicesProvider>;
        shell?: string;
        sqlitePath?: string;
        types?: Type.Entity.Any[];
    }
    Index

    Properties

    config? createOpfsWorker? createWorker? services? shell? sqlitePath? types?

    Properties

    config?: Config

    Client configuration object.

    createOpfsWorker?: () => Worker

    When running in the host mode, a factory to create the worker for OPFS sqlite database.

    createWorker?: () => SharedWorker

    Create client worker.

    services?: MaybePromise<ClientServicesProvider>

    Custom services provider.

    shell?: string

    Shell path.

    sqlitePath?: string

    Path to SQLite database file for persistent indexing in Node/Bun. Dervied from config's dataRoot.

    types?: Type.Entity.Any[]

    ECHO schema.

    Settings

    Member Visibility

    On This Page

    Properties