@nickyzj2023/utils 1.0.9 → 1.0.11

package/docs/functions/withCache.html

@@ -5,8 +5,8 @@
 </div></li><li><span><span class="tsd-kind-parameter">ttlSeconds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -1</span></span><div class="tsd-comment tsd-typography"><p>以秒为单位的过期时间，-1 表示永不过期，默认 -1，会被回调函数里的 setTtl() 覆盖</p>
 </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-call-signature">clear</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-call-signature">updateTtl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheargs">Args</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheresult">Result</a> <span class="tsd-signature-symbol">}</span></h4><p>返回包装后的函数，以及缓存相关的额外方法</p>
 <ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheargs">Args</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheresult">Result</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheargs">Args</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#withcacheresult">Result</a></h4></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">clear</span><span class="tsd-signature-symbol">:</span> function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><span class="tsd-kind-call-signature">clear</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>手动清除缓存</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in hoc.ts:90</li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateTtl</span><span class="tsd-signature-symbol">:</span> function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><span class="tsd-kind-call-signature">updateTtl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>更新 TTL，同时刷新所有未过期缓存的时间</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in hoc.ts:93</li></ul></aside></div></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// 异步函数示例</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">fetchData</span><span class="hl-2"> = </span><span class="hl-1">withCache</span><span class="hl-2">(</span><span class="hl-6">async</span><span class="hl-2"> (</span><span class="hl-5">setTtl</span><span class="hl-2">, </span><span class="hl-5">url</span><span class="hl-2">: </span><span class="hl-8">string</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2">  </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">data</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetch</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">res</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">res</span><span class="hl-2">.</span><span class="hl-1">json</span><span class="hl-2">());</span><br/><span class="hl-2">  </span><span class="hl-1">setTtl</span><span class="hl-2">(</span><span class="hl-5">data</span><span class="hl-2">.</span><span class="hl-5">expiresIn</span><span class="hl-2">);  </span><span class="hl-0">// 根据实际情况调整过期时间</span><br/><span class="hl-2">  </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">data</span><span class="hl-2">;</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">);</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">);</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><br/><span class="hl-5">fetchData</span><span class="hl-2">.</span><span class="hl-1">clear</span><span class="hl-2">(); </span><span class="hl-0">// urlA 和 urlB 的缓存都被清除</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 重新请求数据</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 重新请求数据</span><br/><br/><span class="hl-0">// 缓存过期前</span><br/><span class="hl-5">fetchData</span><span class="hl-2">.</span><span class="hl-1">updateTtl</span><span class="hl-2">(</span><span class="hl-9">180</span><span class="hl-2">);  </span><span class="hl-0">// 更新 ttl 并为所有未过期缓存续期</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Nickyzj628/utils/blob/f2adbe8702c0f8095be72e5e5f12883be8bf50d8/src/hoc.ts#L90">hoc.ts:90</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateTtl</span><span class="tsd-signature-symbol">:</span> function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><span class="tsd-kind-call-signature">updateTtl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>更新 TTL，同时刷新所有未过期缓存的时间</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Nickyzj628/utils/blob/f2adbe8702c0f8095be72e5e5f12883be8bf50d8/src/hoc.ts#L93">hoc.ts:93</a></li></ul></aside></div></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// 异步函数示例</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">fetchData</span><span class="hl-2"> = </span><span class="hl-1">withCache</span><span class="hl-2">(</span><span class="hl-6">async</span><span class="hl-2"> (</span><span class="hl-5">setTtl</span><span class="hl-2">, </span><span class="hl-5">url</span><span class="hl-2">: </span><span class="hl-8">string</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2">  </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">data</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetch</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">res</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">res</span><span class="hl-2">.</span><span class="hl-1">json</span><span class="hl-2">());</span><br/><span class="hl-2">  </span><span class="hl-1">setTtl</span><span class="hl-2">(</span><span class="hl-5">data</span><span class="hl-2">.</span><span class="hl-5">expiresIn</span><span class="hl-2">);  </span><span class="hl-0">// 根据实际情况调整过期时间</span><br/><span class="hl-2">  </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">data</span><span class="hl-2">;</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">);</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">);</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><br/><span class="hl-5">fetchData</span><span class="hl-2">.</span><span class="hl-1">clear</span><span class="hl-2">(); </span><span class="hl-0">// urlA 和 urlB 的缓存都被清除</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 重新请求数据</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 重新请求数据</span><br/><br/><span class="hl-0">// 缓存过期前</span><br/><span class="hl-5">fetchData</span><span class="hl-2">.</span><span class="hl-1">updateTtl</span><span class="hl-2">(</span><span class="hl-9">180</span><span class="hl-2">);  </span><span class="hl-0">// 更新 ttl 并为所有未过期缓存续期</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlA</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetchData</span><span class="hl-2">(</span><span class="hl-5">urlB</span><span class="hl-2">); </span><span class="hl-0">// 使用缓存结果</span>
 </code><button type="button">Copy</button></pre>
 
-</div></div><aside class="tsd-sources"><ul><li>Defined in hoc.ts:42</li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nickyzj2023/utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Nickyzj628/utils/blob/f2adbe8702c0f8095be72e5e5f12883be8bf50d8/src/hoc.ts#L42">hoc.ts:42</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nickyzj2023/utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/package.json

@@ -1,22 +1,22 @@
-{
-  "name": "@nickyzj2023/utils",
-  "version": "1.0.9",
-  "type": "module",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "docs": "typedoc src/index.ts",
-    "build": "bun build --target=bun --outdir ./dist --minify ./src/index.ts && tsc && bun run docs"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "typedoc": "^0.28.14"
-  },
-  "peerDependencies": {
-    "typescript": "^5"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Nickyzj628/utils.git"
-  }
-}
+{
+  "name": "@nickyzj2023/utils",
+  "version": "1.0.11",
+  "type": "module",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "docs": "typedoc src/index.ts",
+    "build": "bun build --target=bun --outdir ./dist --minify ./src/index.ts && tsc && bun run docs"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typedoc": "^0.28.14"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Nickyzj628/utils.git"
+  }
+}

package/src/dom.ts

@@ -1,10 +1,10 @@
-/**
- * 附带时间的 console.log
- * @param args
- *
- * @example
- * timeLog("Hello", "World"); // 14:30:00 Hello World
- */
-export const timeLog = (...args: any[]) => {
-  console.log(`${new Date().toLocaleTimeString()}`, ...args);
-};
+/**
+ * 附带时间的 console.log
+ * @param args
+ *
+ * @example
+ * timeLog("Hello", "World"); // 14:30:00 Hello World
+ */
+export const timeLog = (...args: any[]) => {
+  console.log(`${new Date().toLocaleTimeString()}`, ...args);
+};

package/src/hoc.ts

@@ -1,109 +1,109 @@
-type SetTtl = (seconds: number) => void;
-
-type CacheEntry = {
-  value: any;
-  expiresAt: number; // 时间戳（毫秒）
-};
-
-/**
- * 创建一个带缓存的高阶函数
- *
- * @template Args 被包装函数的参数类型数组
- * @template Result 被包装函数的返回类型
- *
- * @param fn 需要被缓存的函数，参数里附带的 setTtl 方法用于根据具体情况改写过期时间
- * @param ttlSeconds 以秒为单位的过期时间，-1 表示永不过期，默认 -1，会被回调函数里的 setTtl() 覆盖
- *
- * @returns 返回包装后的函数，以及缓存相关的额外方法
- *
- * @example
- * // 异步函数示例
- * const fetchData = withCache(async (setTtl, url: string) => {
- *   const data = await fetch(url).then((res) => res.json());
- *   setTtl(data.expiresIn);  // 根据实际情况调整过期时间
- *   return data;
- * });
- *
- * await fetchData(urlA);
- * await fetchData(urlA); // 使用缓存结果
-
- * await fetchData(urlB);
- * await fetchData(urlB); // 使用缓存结果
- *
- * fetchData.clear(); // urlA 和 urlB 的缓存都被清除
- * await fetchData(urlA); // 重新请求数据
- * await fetchData(urlB); // 重新请求数据
- *
- * // 缓存过期前
- * fetchData.updateTtl(180);  // 更新 ttl 并为所有未过期缓存续期
- * await fetchData(urlA); // 使用缓存结果
- * await fetchData(urlB); // 使用缓存结果
- */
-export const withCache = <Args extends any[], Result>(
-  fn: (setTtl: SetTtl, ...args: Args) => Result,
-  ttlSeconds = -1,
-) => {
-  const cache = new Map<string, CacheEntry>();
-
-  const wrapped = (...args: Args): Result => {
-    const key = JSON.stringify(args);
-    const now = Date.now();
-    const entry = cache.get(key);
-
-    // 命中缓存且未过期
-    if (entry && now < entry.expiresAt) {
-      return entry.value;
-    }
-
-    const setTtl: SetTtl = (seconds) => (ttlSeconds = seconds);
-    const result = fn(setTtl, ...args);
-
-    // 异步函数：缓存 Promise 的 resolved 值
-    if (result instanceof Promise) {
-      const promise = result.then((resolved) => {
-        cache.set(key, {
-          value: resolved,
-          expiresAt: Date.now() + ttlSeconds * 1000,
-        });
-        return resolved;
-      });
-
-      // 将 promise 先塞进去避免重复请求
-      cache.set(key, {
-        value: promise,
-        expiresAt: now + ttlSeconds * 1000,
-      });
-
-      return promise as Result;
-    }
-
-    // 同步函数缓存
-    cache.set(key, {
-      value: result,
-      expiresAt: now + ttlSeconds * 1000,
-    });
-
-    return result;
-  };
-
-  /** 手动清除缓存 */
-  wrapped.clear = () => cache.clear();
-
-  /** 更新 TTL，同时刷新所有未过期缓存的时间 */
-  wrapped.updateTtl = (seconds: number) => {
-    // 更新默认 TTL
-    ttlSeconds = seconds;
-
-    // 给未过期缓存续期
-    const now = Date.now();
-    const newExpiresAt = now + seconds * 1000;
-    for (const [key, entry] of cache.entries()) {
-      if (entry.expiresAt > now) {
-        entry.expiresAt = newExpiresAt;
-        cache.set(key, entry);
-      }
-    }
-  };
-
-  return wrapped;
-};
+type SetTtl = (seconds: number) => void;
+
+type CacheEntry = {
+  value: any;
+  expiresAt: number; // 时间戳（毫秒）
+};
+
+/**
+ * 创建一个带缓存的高阶函数
+ *
+ * @template Args 被包装函数的参数类型数组
+ * @template Result 被包装函数的返回类型
+ *
+ * @param fn 需要被缓存的函数，参数里附带的 setTtl 方法用于根据具体情况改写过期时间
+ * @param ttlSeconds 以秒为单位的过期时间，-1 表示永不过期，默认 -1，会被回调函数里的 setTtl() 覆盖
+ *
+ * @returns 返回包装后的函数，以及缓存相关的额外方法
+ *
+ * @example
+ * // 异步函数示例
+ * const fetchData = withCache(async (setTtl, url: string) => {
+ *   const data = await fetch(url).then((res) => res.json());
+ *   setTtl(data.expiresIn);  // 根据实际情况调整过期时间
+ *   return data;
+ * });
+ *
+ * await fetchData(urlA);
+ * await fetchData(urlA); // 使用缓存结果
+
+ * await fetchData(urlB);
+ * await fetchData(urlB); // 使用缓存结果
+ *
+ * fetchData.clear(); // urlA 和 urlB 的缓存都被清除
+ * await fetchData(urlA); // 重新请求数据
+ * await fetchData(urlB); // 重新请求数据
+ *
+ * // 缓存过期前
+ * fetchData.updateTtl(180);  // 更新 ttl 并为所有未过期缓存续期
+ * await fetchData(urlA); // 使用缓存结果
+ * await fetchData(urlB); // 使用缓存结果
+ */
+export const withCache = <Args extends any[], Result>(
+  fn: (setTtl: SetTtl, ...args: Args) => Result,
+  ttlSeconds = -1,
+) => {
+  const cache = new Map<string, CacheEntry>();
+
+  const wrapped = (...args: Args): Result => {
+    const key = JSON.stringify(args);
+    const now = Date.now();
+    const entry = cache.get(key);
+
+    // 命中缓存且未过期
+    if (entry && now < entry.expiresAt) {
+      return entry.value;
+    }
+
+    const setTtl: SetTtl = (seconds) => (ttlSeconds = seconds);
+    const result = fn(setTtl, ...args);
+
+    // 异步函数：缓存 Promise 的 resolved 值
+    if (result instanceof Promise) {
+      const promise = result.then((resolved) => {
+        cache.set(key, {
+          value: resolved,
+          expiresAt: Date.now() + ttlSeconds * 1000,
+        });
+        return resolved;
+      });
+
+      // 将 promise 先塞进去避免重复请求
+      cache.set(key, {
+        value: promise,
+        expiresAt: now + ttlSeconds * 1000,
+      });
+
+      return promise as Result;
+    }
+
+    // 同步函数缓存
+    cache.set(key, {
+      value: result,
+      expiresAt: now + ttlSeconds * 1000,
+    });
+
+    return result;
+  };
+
+  /** 手动清除缓存 */
+  wrapped.clear = () => cache.clear();
+
+  /** 更新 TTL，同时刷新所有未过期缓存的时间 */
+  wrapped.updateTtl = (seconds: number) => {
+    // 更新默认 TTL
+    ttlSeconds = seconds;
+
+    // 给未过期缓存续期
+    const now = Date.now();
+    const newExpiresAt = now + seconds * 1000;
+    for (const [key, entry] of cache.entries()) {
+      if (entry.expiresAt > now) {
+        entry.expiresAt = newExpiresAt;
+        cache.set(key, entry);
+      }
+    }
+  };
+
+  return wrapped;
+};

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from "./dom";
-export * from "./hoc";
-export * from "./is";
-export * from "./network";
+export * from "./dom";
+export * from "./hoc";
+export * from "./is";
+export * from "./network";

package/src/is.ts

@@ -1,8 +1,8 @@
-/**
- * 检测传入的值是否为**普通对象**
- * @param value
- * @returns {Boolean} 如果是普通对象，返回 true，否则返回 false
- */
-export const isObject = (value: any): value is object => {
-  return value?.constructor === Object;
-};
+/**
+ * 检测传入的值是否为**普通对象**
+ * @param value
+ * @returns {Boolean} 如果是普通对象，返回 true，否则返回 false
+ */
+export const isObject = (value: any): value is object => {
+  return value?.constructor === Object;
+};

package/src/lru-cache.ts

@@ -1,50 +1,50 @@
-/**
- * 简易 LRU 缓存
- * @example
- * const cache = new LRUCache<string, number>(2);
- * cache.set("a", 1);
- * cache.set("b", 2);
- * cache.set("c", 3);    // 缓存已满，a 被淘汰
- * cache.get("a");    // undefined
- */
-class LRUCache<K, V> {
-  private cache: Map<K, V>;
-  private maxSize: number;
-
-  constructor(maxSize = 10) {
-    this.cache = new Map();
-    this.maxSize = maxSize;
-  }
-
-  get(key: K): V | undefined {
-    const value = this.cache.get(key);
-    if (!value) {
-      return undefined;
-    }
-    // 重置缓存顺序
-    this.cache.delete(key);
-    this.cache.set(key, value);
-    return value;
-  }
-
-  set(key: K, value: V) {
-    // 刷新缓存
-    if (this.cache.has(key)) {
-      this.cache.delete(key);
-    }
-    // 删除最旧的缓存
-    else if (this.cache.size >= this.maxSize) {
-      const oldestKey = [...this.cache.keys()][0];
-      if (oldestKey) {
-        this.cache.delete(oldestKey);
-      }
-    }
-    this.cache.set(key, value);
-  }
-
-  has(key: K) {
-    return this.cache.has(key);
-  }
-}
-
-export default LRUCache;
+/**
+ * 简易 LRU 缓存
+ * @example
+ * const cache = new LRUCache<string, number>(2);
+ * cache.set("a", 1);
+ * cache.set("b", 2);
+ * cache.set("c", 3);    // 缓存已满，a 被淘汰
+ * cache.get("a");    // undefined
+ */
+class LRUCache<K, V> {
+  private cache: Map<K, V>;
+  private maxSize: number;
+
+  constructor(maxSize = 10) {
+    this.cache = new Map();
+    this.maxSize = maxSize;
+  }
+
+  get(key: K): V | undefined {
+    const value = this.cache.get(key);
+    if (!value) {
+      return undefined;
+    }
+    // 重置缓存顺序
+    this.cache.delete(key);
+    this.cache.set(key, value);
+    return value;
+  }
+
+  set(key: K, value: V) {
+    // 刷新缓存
+    if (this.cache.has(key)) {
+      this.cache.delete(key);
+    }
+    // 删除最旧的缓存
+    else if (this.cache.size >= this.maxSize) {
+      const oldestKey = [...this.cache.keys()][0];
+      if (oldestKey) {
+        this.cache.delete(oldestKey);
+      }
+    }
+    this.cache.set(key, value);
+  }
+
+  has(key: K) {
+    return this.cache.has(key);
+  }
+}
+
+export default LRUCache;