@kisaragi-hiu/cached-fetch 0.1.1 → 0.2.0

package/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ *
+ * 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: () => string | Promise<string> | Promise<{
+    text: () => string | Promise<string>;
+}>): Promise<string>;

package/index.js

@@ -14,16 +14,22 @@ 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();
+    let text;
+    if (cacheHit) {
+        text = readFileSync(cacheFile, { encoding: "utf-8" });
+    }
+    else {
+        const result = await fetcher();
+        text = typeof result === "string" ? result : await result.text();
+    }
     if (!cacheHit) {
         mkdirSync(dirname(cacheFile), { recursive: true });
         writeFileSync(cacheFile, text, { encoding: "utf-8" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kisaragi-hiu/cached-fetch",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A cache in OS tmpdir useful for fetch()",
   "type": "module",
   "repository": {
@@ -14,7 +14,7 @@
   "homepage": "https://github.com/kisaragi-hiu/cached-fetch",
   "author": "Kisaragi Hiu <mail@kisaragi-hiu.com>",
   "license": "MIT",
-  "files": ["index.js"],
+  "files": ["index.js", "index.d.ts"],
   "devDependencies": {
     "@typescript/native-preview": "^7.0.0-dev.20250822.1"
   },