Interface RedisRedisClientOptions

interface RedisRedisClientOptions {
    autoResendUnfulfilledCommands?: boolean;
    autoResubscribe?: boolean;
    commandsQueueMaxLength?: number;
    connectTimeout?: number;
    database?: number;
    disableOfflineQueue?: boolean;
    enableReadyCheck?: boolean;
    family?: "IPv4" | "IPv6";
    keepAlive?: number;
    keyPrefix?: string;
    lazyConnect?: boolean;
    legacyMode?: boolean;
    name?: string;
    password?: string;
    readonly?: boolean;
    retry?: {
        initialReconnectionDelay?: number;
        maxReconnectionAttempts?: number;
        maxRetryCount?: number;
        reconnectionBackoffFactor?: number;
        totalReconnectionTimeout?: number;
    };
    socket?: {
        host?: string;
        port?: number;
        servername?: string;
        tls?: boolean;
    };
    stringNumbers?: boolean;
    tls?: boolean | ConnectionOptions;
    url?: string;
    username?: string;
}

Properties

autoResendUnfulfilledCommands? autoResubscribe? commandsQueueMaxLength? connectTimeout? database? disableOfflineQueue? enableReadyCheck? family? keepAlive? keyPrefix? lazyConnect? legacyMode? name? password? readonly? retry? socket? stringNumbers? tls? url? username?

Properties

OptionalautoResendUnfulfilledCommands

autoResendUnfulfilledCommands?: boolean

OptionalautoResubscribe

autoResubscribe?: boolean

OptionalcommandsQueueMaxLength

commandsQueueMaxLength?: number

OptionalconnectTimeout

connectTimeout?: number

Optionaldatabase

database?: number

OptionaldisableOfflineQueue

disableOfflineQueue?: boolean

OptionalenableReadyCheck

enableReadyCheck?: boolean

Optionalfamily

family?: "IPv4" | "IPv6"

OptionalkeepAlive

keepAlive?: number

OptionalkeyPrefix

keyPrefix?: string

OptionallazyConnect

lazyConnect?: boolean

OptionallegacyMode

legacyMode?: boolean

Optionalname

name?: string

Optionalpassword

password?: string

Optionalreadonly

readonly?: boolean

Optionalretry

retry?: {
    initialReconnectionDelay?: number;
    maxReconnectionAttempts?: number;
    maxRetryCount?: number;
    reconnectionBackoffFactor?: number;
    totalReconnectionTimeout?: number;
}

Optionalsocket

socket?: {
    host?: string;
    port?: number;
    servername?: string;
    tls?: boolean;
}

OptionalstringNumbers

stringNumbers?: boolean

Optionaltls

tls?: boolean | ConnectionOptions

Optionalurl

url?: string

Optionalusername

username?: string

Settings

Member Visibility

On This Page

Properties