prorm API Reference
    Preparing search index...

    Interface HBaseStoreOptions

    Connection options for HBaseStore. These map onto the hbase client constructor options (a Stargate / REST gateway host + port).

    interface HBaseStoreOptions {
        host?: string;
        port?: number;
        clientOptions?: Record<string, unknown>;
        client?: HBaseClientLike;
    }
    Index
    host? port? clientOptions? client?
    host?: string

    REST/Stargate gateway host, e.g. '127.0.0.1'.

    port?: number

    REST/Stargate gateway port, e.g. 8080.

    clientOptions?: Record<string, unknown>

    Escape hatch for any other hbase client option (protocol, encoding, auth, timeout, ...). Merged into the options passed to the client factory.

    client?: HBaseClientLike

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

    Settings
    Member Visibility

    On This Page
    Properties