@ziggurat-cache/redis

Redis adapter for the Ziggurat multi-layer cache.

Installation

npm install @ziggurat-cache/core @ziggurat-cache/redis ioredis

Usage

import { CacheManager, MemoryAdapter } from "@ziggurat-cache/core";
import { RedisAdapter } from "@ziggurat-cache/redis";
import Redis from "ioredis";

const cache = new CacheManager({
  layers: [
    new MemoryAdapter({ defaultTtlMs: 30_000 }), // L1: fast, in-process
    new RedisAdapter({
      // L2: shared, persistent
      client: new Redis(),
      defaultTtlMs: 600_000,
    }),
  ],
});

const user = await cache.wrap(`user:${id}`, async () => db.users.findById(id));

Options

interface RedisAdapterOptions {
  client: Redis; // ioredis client instance
  defaultTtlMs?: number; // Default TTL in milliseconds
  prefix?: string; // Key prefix (default: none)
}

Requirements

• ioredis >= 5.0.0 (peer dependency)

Documentation

See the Redis Adapter guide for configuration details, serialization, and production tips.

License

MIT