@agrodt/astro-redis-cache-provider

Custom Redis cache provider for Astro route caching, powered by node-redis.

Install

pnpm add @agrodt/astro-redis-cache-provider
Copy

node-redis already comes as a dependency of this package. You only need a reachable Redis server.

Usage

// astro.config.mjs
import { defineConfig } from "astro/config";
import { redisCache } from "@agrodt/astro-redis-cache-provider/config";

export default defineConfig({
  experimental: {
    cache: {
      provider: redisCache({
        url: () => process.env.REDIS_URL,
        keyPrefix: "astro:cache",
      }),
    },
  },
});
Copy

Options

type RedisCacheProviderOptions = {
  url?: string | (() => string | undefined);
  keyPrefix?: string;
  revalidateLockTtl?: number;
  ignoredVaryHeaders?: Iterable<string>;
  query?: {
    include?: string[];
    exclude?: string[];
    sort?: boolean;
  };
};
Copy

• url: Redis URL string or runtime factory (() => string | undefined), for example redis://localhost:6379 or () => process.env.REDIS_URL.
• keyPrefix: Prefix for all Redis keys. Default: astro:cache.
• revalidateLockTtl: Lock lifetime in seconds for stale background revalidation. Default: 30.
• ignoredVaryHeaders: Additional Vary headers to ignore during cache matching (for example ["cookie"]). set-cookie is always ignored.
• query: Same query normalization semantics as Astro memory provider (include/exclude are mutually exclusive).

Example

See example for a runnable Astro app that demonstrates MISS/HIT behavior and manual invalidation.