IFClite TypeScript API
    Preparing search index...

    Interface RedisLikeClient

    Minimal Redis-like surface. The two big Node clients (ioredis, node-redis 4+) both satisfy this when wrapped trivially. Buffers are returned for binary fidelity.

    interface RedisLikeClient {
        del(...keys: string[]): Promise<unknown>;
        getBuffer(key: string): Promise<Buffer<ArrayBufferLike> | null>;
        lrangeBuffer(key: string): Promise<Buffer<ArrayBufferLike>[]>;
        ltrim(key: string, start: number, stop: number): Promise<unknown>;
        rpush(key: string, value: Buffer): Promise<unknown>;
        set(key: string, value: Buffer): Promise<unknown>;
    }
    Index
    del getBuffer lrangeBuffer ltrim rpush set

    • DEL one or more keys.

      Parameters

      • ...keys: string[]

      Returns Promise<unknown>

    • Get a binary string value, or null if missing.

      Parameters

      • key: string

      Returns Promise<Buffer<ArrayBufferLike> | null>

    • LRANGE 0 -1 returning all binary items in order.

      Parameters

      • key: string

      Returns Promise<Buffer<ArrayBufferLike>[]>

    • LTRIM .

      Parameters

      • key: string
      • start: number
      • stop: number

      Returns Promise<unknown>

    • RPUSH a buffer onto a list.

      Parameters

      • key: string
      • value: Buffer

      Returns Promise<unknown>

    • Set a binary string value (no expiry by default).

      Parameters

      • key: string
      • value: Buffer

      Returns Promise<unknown>

    Settings
    Member Visibility

    On This Page
    Methods