prorm API Reference
    Preparing search index...

    Interface LmdbStoreOptions

    Connection options for LmdbStore.

    interface LmdbStoreOptions {
        path?: string;
        config?: Record<string, unknown>;
        client?: LmdbClientLike;
    }
    Index
    path? config? client?
    path?: string

    Filesystem path for the LMDB environment. Defaults to './data/lmdb'.

    config?: Record<string, unknown>

    Escape hatch for any other lmdb open() option (compression, maxDbs, encoding, ...). Merged into the object passed to open().

    client?: LmdbClientLike

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

    Settings
    Member Visibility

    On This Page
    Properties