✨ Cache

Default Cache

Access to the default cache is enabled by default:

addEventListener("fetch", (e) => {
  e.respondWith(caches.default.match("http://miniflare.dev"));
});

Named Caches

You can access a namespaced cache using open. Note that you cannot name your cache default, trying to do so will throw an error:

await caches.open("cache_name");

Persistence

By default, cached data is stored in memory. It will persist between reloads, but not CLI invocations or different Miniflare instances. To enable persistence to the file system or Redis, specify the cache persistence option:

$ miniflare --cache-persist # Defaults to ./.mf/cache
$ miniflare --cache-persist ./data/  # Custom path
$ miniflare --cache-persist redis://localhost:6379  # Redis server
# wrangler.toml
[miniflare]
cache_persist = true # Defaults to ./.mf/cache
cache_persist = "./data/" # Custom path
cache_persist = "redis://localhost:6379" # Redis server
const mf = new Miniflare({
  cachePersist: true, // Defaults to ./.mf/cache
  cachePersist: "./data", // Custom path
  cachePersist: "redis://localhost:6379", // Redis server
});

When using the file system, each namespace will get its own directory within the cache persistence directory.

When using Redis, each key will be prefixed with the namespace. If you're using this with the API, make sure you call dispose on your Miniflare instance to close database connections.

Manipulating Outside Workers

For testing, it can be useful to put/match data from cache outside a worker. You can do this with the getCache method:























 
 
 
 
 
 
 
 
 
 
 



import { Miniflare, Response } from "miniflare";

const mf = new Miniflare({
  modules: true,
  script: `
  export default {
    async fetch(request) {
      const url = new URL(request.url);
      const cache = caches.default;
      if(url.pathname === "/put") {
        await cache.put("https://miniflare.dev/", new Response("1", {
          headers: { "Cache-Control": "max-age=3600" },
        }));
      }
      return cache.match("https://miniflare.dev/");
    }
  }
  `,
});
let res = await mf.dispatchFetch("http://localhost:8787/put");
console.log(await res.text()); // 1

const cache = await mf.getCache(); // Gets the default cache
const namedCache = await mf.getCache("cache_name"); // Gets a namespaced cache
const cachedRes = await cache.match("https://miniflare.dev/");
console.log(await cachedRes.text()); // 1

await cache.put(
  "https://miniflare.dev",
  new Response("2", {
    headers: { "Cache-Control": "max-age=3600" },
  })
);
res = await mf.dispatchFetch("http://localhost:8787");
console.log(await res.text()); // 2

Disabling

Both default and named caches can be disabled with the disableCache option. When disabled, the caches will still be available in the sandbox, they just won't cache anything. This may be useful during development:

$ miniflare --disable-cache
# wrangler.toml
[miniflare]
disable_cache = true
const mf = new Miniflare({
  disableCache: true,
});