|
1 | 1 | <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@stephen-shopopop/cache</title><meta name="description" content="Documentation for @stephen-shopopop/cache"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@stephen-shopopop/cache</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@stephen-shopopop/cache</h1></div><div class="tsd-panel tsd-typography"><p><a href="https://www.npmjs.com/package/@stephen-shopopop/cache"><img src="https://img.shields.io/npm/v/@stephen-shopopop/cache.svg" alt="npm version"></a> |
2 | | -<a href="./"><img src="https://img.shields.io/badge/coverage-80%25-brightgreen" alt="Coverage Status"></a> |
| 2 | +<a href="./"><img src="https://img.shields.io/badge/coverage-96%25-brightgreen" alt="Coverage Status"></a> |
3 | 3 | <a href="https://github.com/stephen-shopopop/node-cache/actions/workflows/ci.yml"><img src="https://github.com/stephen-shopopop/node-cache/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a></p> |
4 | 4 | <h1 id="node-cache" class="tsd-anchor-link">node-cache<a href="#node-cache" 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></h1><p>A high-performance, strongly-typed caching library for Node.js, supporting in-memory (LRU, TTL), metadata, and persistent SQLite backends. Designed for reliability, flexibility, and modern TypeScript/ESM workflows.</p> |
5 | 5 | <ul> |
@@ -354,7 +354,6 @@ <h2 id="📊-performance-comparison" class="tsd-anchor-link">📊 Performance Co |
354 | 354 | </tbody> |
355 | 355 | </table> |
356 | 356 | <p><em>Bench run on Apple M1, Node.js 24.7.0, <code>npm run bench</code> — complex workflow = set, get, update, delete, hit/miss, TTL, metadata.</em></p> |
357 | | -<p><em>Bench run on Apple M1, Node.js 24.7.0, <code>npm run bench</code></em></p> |
358 | 357 | <h2 id="⚠️-performance-limits-by-backend" class="tsd-anchor-link">⚠️ Performance limits by backend<a href="#⚠️-performance-limits-by-backend" 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></h2><p>Each backend has different performance characteristics and is suited for different use cases:</p> |
359 | 358 | <table> |
360 | 359 | <thead> |
@@ -455,7 +454,7 @@ <h4 id="minimal-test-example-nodetest" class="tsd-anchor-link">Minimal test exam |
455 | 454 | <h3 id="before-submitting-a-pr" class="tsd-anchor-link">Before Submitting a PR<a href="#before-submitting-a-pr" 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></h3><ol> |
456 | 455 | <li>Make sure all tests pass (<code>npm run test</code>)</li> |
457 | 456 | <li>Check lint and formatting (<code>npm run lint && npm run format</code>)</li> |
458 | | -<li>Check coverage (<code>npm run test -- --coverage</code>)</li> |
| 457 | +<li>Check coverage (<code>npm run coverage</code>)</li> |
459 | 458 | <li>Add/complete documentation if needed</li> |
460 | 459 | <li>Clearly describe your contribution in the PR</li> |
461 | 460 | <li>Use clear, conventional commit messages</li> |
|
0 commit comments