edgeport - v1.0.6
    Preparing search index...

    Interface RedisConnectOptions

    Options for connect.

    1.0.6

    interface RedisConnectOptions {
        clientName?: string;
        db?: number;
        hostname: string;
        password?: string;
        port?: number;
        protocol?: 2 | 3;
        timeoutMs?: number;
        tls?: "off" | "implicit";
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    clientName? db? hostname password? port? protocol? timeoutMs? tls? username?
    clientName?: string

    Connection name to register (HELLO ... SETNAME or CLIENT SETNAME).

    db?: number

    Database index to SELECT after authenticating.

    hostname: string

    Remote Redis host.

    password?: string

    Password for AUTH, or for the HELLO ... AUTH clause when protocol: 3.

    port?: number

    Remote port; defaults to 6379.

    protocol?: 2 | 3

    RESP protocol version: 2 (default) or 3.

    RESP2 works against every Redis version. RESP3 requires Redis 6 or newer and is not negotiated down - an older server fails the connect rather than silently falling back, because the two versions return different reply shapes for the same command.

    timeoutMs?: number

    Read deadline in milliseconds for the connect handshake.

    tls?: "off" | "implicit"

    Transport security:

    • 'off' (default): plaintext.
    • 'implicit': TLS from the first byte, for a server with tls-port configured.

    Redis has no in-band upgrade, so there is no 'starttls' mode.

    username?: string

    ACL username (Redis 6+); pair with password. Omit for a requirepass-only server.

    Settings
    Member Visibility

    On This Page
    Properties