@kisaragi-hiu/cached-fetch 0.1.2 → 0.3.0

package/index.d.ts

@@ -1,19 +1,4 @@
-/**
- * A cache designed to cache some text.
- */
-export declare function cached(
-/**
- * The key of the value.
- * Subsequent calls with the same key will return the cached value.
- */
-key: string, 
-/**
- * A fetcher function, called when the value isn't cached.
- *
- * Should return a Promise<{ text: () => string | Promise<string> }>. This is
- * usually a Response, but ProcessOutput from the zx library also fits
- * this signature.
- */
-fetcher: () => Promise<{
+export declare function cached(key: string, fetcher: () => string): string;
+export declare function cached(key: string, fetcher: () => Promise<string> | Promise<{
     text: () => string | Promise<string>;
 }>): Promise<string>;

package/index.js

@@ -1,11 +1,11 @@
 // -*- lsp-disabled-clients: (ts-ls); -*-
-import { mkdirSync, writeFileSync, readFileSync, existsSync } from "node:fs";
+import { mkdirSync, writeFileSync, readFileSync } from "node:fs";
 import { dirname, join } from "node:path";
 import { tmpdir } from "node:os";
 /**
  * A cache designed to cache some text.
  */
-export async function cached(
+export function cached(
 /**
  * The key of the value.
  * Subsequent calls with the same key will return the cached value.
@@ -14,19 +14,33 @@ key,
 /**
  * A fetcher function, called when the value isn't cached.
  *
- * Should return a Promise<{ text: () => string | Promise<string> }>. This is
- * usually a Response, but ProcessOutput from the zx library also fits
- * this signature.
+ * This can return a string or a Promise<string>.
+ *
+ * This can also return a Promise<{ text: () => string | Promise<string> }>.
+ * This means a Response or zx's ProcessOutput can be used directly.
  */
 fetcher) {
     const cacheFile = join(tmpdir(), key);
-    const cacheHit = existsSync(cacheFile);
-    const text = cacheHit
-        ? readFileSync(cacheFile, { encoding: "utf-8" })
-        : await (await fetcher()).text();
-    if (!cacheHit) {
+    function saveCache(text) {
         mkdirSync(dirname(cacheFile), { recursive: true });
         writeFileSync(cacheFile, text, { encoding: "utf-8" });
+        return text;
+    }
+    try {
+        return readFileSync(cacheFile, { encoding: "utf-8" });
+    }
+    catch (e) {
+        if (e.code !== "ENOENT") {
+            throw e;
+        }
+        const result = fetcher();
+        if (typeof result === "string") {
+            return saveCache(result);
+        }
+        else {
+            return result.then(async (v) => {
+                return saveCache(typeof v === "string" ? v : await v.text());
+            });
+        }
     }
-    return text;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kisaragi-hiu/cached-fetch",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "A cache in OS tmpdir useful for fetch()",
   "type": "module",
   "repository": {
@@ -19,6 +19,7 @@
     "@typescript/native-preview": "^7.0.0-dev.20250822.1"
   },
   "scripts": {
+    "test": "deno test -A",
     "build": "tsgo index.ts --noCheck -d -t esnext -m nodenext"
   }
 }