nuxt-compressed-cache 0.1.1 → 0.1.2

package/README.md

@@ -119,7 +119,7 @@ export default defineNuxtConfig({
 | `gzipLevel` | `6` | Gzip level, used once per render. |
 | `statusHeader` | `'x-cache'` | Header that reports `HIT`, `STALE` or `MISS`. `false` omits it. |
 | `invalidateOnBuild` | `true` | Tie entries to the build. After a deploy that keeps the storage, pages render again before they are sent, and payloads are kept per build (see [Payloads](#payloads)). |
-| `cleanup` | `false` | Enable Nitro's scheduled pruning task. `true` runs daily at 04:00 and removes expired entries (see [Server helpers](#server-helpers)). An object can override `schedule` (cron) and set `olderThan` (seconds) to remove by age instead. |
+| `cleanup` | `false` | Enable Nitro's scheduled pruning task. `true` runs daily at 04:00 and removes expired entries (see [Server helpers](#server-helpers)). An object can override `schedule` (cron) and set `olderThan` (seconds) to remove by age instead, where `0` removes every entry on each run. An invalid `olderThan` logs a warning and falls back to expiry. |
 
 ## Server helpers
 
@@ -139,6 +139,9 @@ await pruneCompressedCache()
 
 // or delete entries rendered more than `olderThan` seconds ago, whatever their rule
 await pruneCompressedCache({ olderThan: 7 * 24 * 60 * 60 })
+
+// or delete every entry
+await pruneCompressedCache({ olderThan: 0 })
 ```
 
 Without `staleMaxAge`, a stale copy is served until a visit replaces it, so pruning only removes pages nobody

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=5.0.0-0"
   },
-  "version": "0.1.1",
+  "version": "0.1.2",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -28,7 +28,8 @@ const module$1 = defineNuxtModule({
       ...options,
       storage: mount,
       version: invalidateOnBuild ? nuxt.options.buildId : void 0,
-      cleanup: cleanup ? { olderThan } : false
+      // runtime config turns an `undefined` value into `''`, so an unset `olderThan` is left out
+      cleanup: cleanup ? olderThan === void 0 ? {} : { olderThan } : false
     };
     if (cleanup) {
       const nitro = nuxt.options.nitro;

package/dist/runtime/tasks/prune.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Reads `cleanup.olderThan`, which arrives as a string from an env override. `0` removes every entry on each run.
+ * Unset (`undefined` or `''`) and invalid values prune by expiry, an invalid value also warns.
+ *
+ * @returns Seconds, or `undefined` to prune by expiry.
+ */
+export declare function parseOlderThan(value: unknown): number | undefined;
 /** Removes expired entries, or ones older than `cleanup.olderThan`, from the module's configured storage and prefix. */
 declare const _default: import("nitro/types").Task<number>;
 export default _default;

package/dist/runtime/tasks/prune.js

@@ -1,10 +1,21 @@
 import { useRuntimeConfig } from "nitro/runtime-config";
 import { defineTask } from "nitro/task";
 import { pruneCompressedCache } from "../server-utils.js";
+export function parseOlderThan(value) {
+  if (value === void 0 || value === "") {
+    return void 0;
+  }
+  const seconds = typeof value === "number" ? value : typeof value === "string" && value.trim() ? Number(value) : Number.NaN;
+  if (Number.isFinite(seconds) && seconds >= 0) {
+    return seconds;
+  }
+  console.warn(`[compressed-cache] ignoring invalid cleanup.olderThan ${JSON.stringify(value)}, pruning by expiry instead`);
+  return void 0;
+}
 export default defineTask({
   meta: { name: "compressed-cache:prune", description: "Prune expired compressed cache entries" },
   async run() {
     const { cleanup } = useRuntimeConfig().compressedCache;
-    return { result: await pruneCompressedCache({ olderThan: cleanup.olderThan }) };
+    return { result: await pruneCompressedCache({ olderThan: parseOlderThan(cleanup.olderThan) }) };
   }
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-compressed-cache",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Serve Nuxt route rules from pre-compressed (brotli/gzip) cached copies, with stale-while-revalidate",
   "author": "Manthankumar Satani",
   "license": "MIT",