prorm API Reference
    Preparing search index...

    Interface PouchdbStoreOptions

    Connection options for PouchdbStore.

    interface PouchdbStoreOptions {
        name?: string;
        config?: Record<string, unknown>;
        client?: PouchClientLike;
    }
    Index
    name? config? client?
    name?: string

    Database name / path passed to new PouchDB(name). Defaults to './data/pouchdb'.

    config?: Record<string, unknown>

    Escape hatch for any other PouchDB constructor option (adapter, auth, ...). Passed as the second argument to new PouchDB(name, config).

    client?: PouchClientLike

    A pre-built pouchdb database (or a compatible mock). When provided, connect() uses it directly and skips require('pouchdb') entirely — this is how tests inject a mock without the real driver installed.

    Settings
    Member Visibility

    On This Page
    Properties