prorm API Reference
    Preparing search index...

    Interface RethinkDBStoreOptions

    Connection options for RethinkDBStore.

    host/port/db configure the connection made by the lazily-required rethinkdb-ts driver. Alternatively, an already-built term-builder (r) and/or an established connection can be injected: when r is provided, connect() uses it as-is and does not require('rethinkdb-ts'); when connection is provided, queries run against it (single-connection mode) instead of a driver-managed pool.

    interface RethinkDBStoreOptions {
        host?: string;
        port?: number;
        db?: string;
        r?: any;
        connection?: any;
    }
    Index
    host? port? db? r? connection?
    host?: string

    RethinkDB host. Defaults to 'localhost'.

    port?: number

    RethinkDB client-driver port. Defaults to 28015.

    db?: string

    Default database queries run against. Defaults to 'test'.

    r?: any

    Injected rethinkdb-ts term-builder. When provided, connect() uses it directly and skips require('rethinkdb-ts') (used by tests to inject a mock, and to share an r configured elsewhere).

    connection?: any

    Injected connection. When provided, queries .run(connection) against it (single-connection mode) rather than relying on the driver's pool.

    Settings
    Member Visibility

    On This Page
    Properties