@storehouse/redis-om - v1.0.0
    Preparing search index...

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

    Configuration argument for creating a RedisOMManager instance.

    const managerArg: RedisOMManagerArg = {
      name: 'my-redis-manager',
      config: {
        models: [userSchema, productSchema],
        options: {
          url: 'redis://localhost:6379'
        }
      }
    };
    interface RedisOMManagerArg<
        M extends RedisModules = RedisDefaultModules,
        F extends RedisFunctions = RedisFunctions,
        S extends RedisScripts = RedisScripts,
        RESP extends RespVersions = 2,
        TYPE_MAPPING extends TypeMapping = TypeMapping,
    > {
        config?: {
            models?: Schema<Record<string, any>>[];
            options?: RedisClientOptions<
                M,
                F,
                S,
                RESP,
                TYPE_MAPPING,
                RedisSocketOptions,
            >;
        };
        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 = 2

      Redis RESP protocol version, defaults to 2

    • TYPE_MAPPING extends TypeMapping = TypeMapping

      Redis type mapping, defaults to TypeMapping

    Hierarchy

    • ManagerArg
      • RedisOMManagerArg
    Index

    Properties

    config? name?

    Properties

    config?: {
        models?: Schema<Record<string, any>>[];
        options?: RedisClientOptions<
            M,
            F,
            S,
            RESP,
            TYPE_MAPPING,
            RedisSocketOptions,
        >;
    }

    Optional configuration for the Redis manager.

    Type Declaration

    • Optionalmodels?: Schema<Record<string, any>>[]

      Array of Redis-OM schemas to register with the manager. Each schema defines the structure of entities stored in Redis.

    • Optionaloptions?: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING, RedisSocketOptions>

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

    name?: string

    Optional name for the manager instance

    Settings

    Member Visibility

    On This Page

    Properties