@storehouse/redis - v0.1.0
    Preparing search index...

    Interface RedisPoolManagerArg<M, F, S, RESP, TYPE_MAPPING>

    Configuration argument for creating a RedisPoolManager instance.

    const managerArg: RedisPoolManagerArg = {
      name: 'my-redis-pool-manager',
      config: {
        options: {
          url: 'redis://localhost:6379'
        }
      }
    };
    interface RedisPoolManagerArg<
        M extends RedisModules = RedisDefaultModules,
        F extends RedisFunctions = RedisFunctions,
        S extends RedisScripts = RedisScripts,
        RESP extends RespVersions = 3,
        TYPE_MAPPING extends TypeMapping = TypeMapping,
    > {
        config?: {
            debugLevel?: number | "error" | "info" | "warn" | "debug";
            options?: Omit<
                RedisClientOptions<M, F, S, RESP, TYPE_MAPPING, RedisSocketOptions>,
                "clientSideCache",
            >;
            poolOptions?: Partial<RedisPoolOptions>;
        };
        name?: string;
    }

    Type Parameters

    • M extends RedisModules = RedisDefaultModules

      Redis modules type, defaults to RedisDefaultModules

    • F extends RedisFunctions = RedisFunctions

      Redis functions type, defaults to RedisFunctions

    • S extends RedisScripts = RedisScripts

      Redis scripts type, defaults to RedisScripts

    • RESP extends RespVersions = 3

      Redis RESP protocol version, defaults to 3

    • TYPE_MAPPING extends TypeMapping = TypeMapping

      Redis type mapping, defaults to TypeMapping

    Hierarchy

    • ManagerArg
      • RedisPoolManagerArg
    Index
    config? name?
    config?: {
        debugLevel?: number | "error" | "info" | "warn" | "debug";
        options?: Omit<
            RedisClientOptions<M, F, S, RESP, TYPE_MAPPING, RedisSocketOptions>,
            "clientSideCache",
        >;
        poolOptions?: Partial<RedisPoolOptions>;
    }

    Optional configuration for the Redis manager.

    Type Declaration

    • OptionaldebugLevel?: number | "error" | "info" | "warn" | "debug"
    • Optionaloptions?: Omit<
          RedisClientOptions<M, F, S, RESP, TYPE_MAPPING, RedisSocketOptions>,
          "clientSideCache",
      >

      Redis client connection options. See redis client documentation for available options.

    • OptionalpoolOptions?: Partial<RedisPoolOptions>
    name?: string

    Optional name for the manager instance

    Settings
    Member Visibility

    On This Page
    Properties