@earth-app/collegedb
    Preparing search index...

    Interface RedisLikeClient

    Minimal Redis/Valkey client contract used by the KV adapter.

    interface RedisLikeClient {
        del(key: string): unknown;
        get(key: string): Promise<string | null>;
        mget?(keys: string[]): Promise<(string | null)[]>;
        mGet?(keys: string[]): Promise<(string | null)[]>;
        mset?(entries: Record<string, string>): unknown;
        mSet?(entries: Record<string, string> | [string, string][]): unknown;
        scan(
            cursor: string,
            ...args: any[],
        ): RedisScanResult | Promise<RedisScanResult>;
        set(key: string, value: string): unknown;
        unlink?(...keys: string[]): unknown;
    }
    Index
    del get mget? mGet? mset? mSet? scan set unlink?

    • Parameters

      • key: string

      Returns unknown

    • Parameters

      • key: string

      Returns Promise<string | null>

    • ioredis spelling of multi-get.

      Parameters

      • keys: string[]

      Returns Promise<(string | null)[]>

      1.4.0

    • Multi-get, present on node-redis and ioredis. Used when available.

      Parameters

      • keys: string[]

      Returns Promise<(string | null)[]>

      1.4.0

    • ioredis spelling of multi-set.

      Parameters

      • entries: Record<string, string>

      Returns unknown

      1.4.0

    • Multi-set, present on node-redis.

      Parameters

      • entries: Record<string, string> | [string, string][]

      Returns unknown

      1.4.0

    • Parameters

      • cursor: string
      • ...args: any[]

      Returns RedisScanResult | Promise<RedisScanResult>

    • Parameters

      • key: string
      • value: string

      Returns unknown

    • Variadic delete, used to clear many keys in one round trip.

      Parameters

      • ...keys: string[]

      Returns unknown

      1.4.0

    Settings
    Member Visibility

    On This Page
    Methods