prorm API Reference
    Preparing search index...

    Interface MaterializeStoreOptions

    Connection options for MaterializeStore (map onto pg client config).

    interface MaterializeStoreOptions {
        host?: string;
        port?: number;
        user?: string;
        password?: string;
        database?: string;
        connectionString?: string;
        connectionOptions?: Record<string, unknown>;
        client?: PgClientLike;
    }
    Index
    host? port? user? password? database? connectionString? connectionOptions? client?
    host?: string
    port?: number
    user?: string
    password?: string
    database?: string
    connectionString?: string

    Full connection string (postgres://...), an alternative to the discrete fields.

    connectionOptions?: Record<string, unknown>

    Escape hatch for any other pg client option.

    client?: PgClientLike

    A pre-built pg Client (or compatible mock). When provided, connect() uses it directly and skips require('pg'). This is how tests inject a mock without the real driver installed.

    Settings
    Member Visibility

    On This Page
    Properties