docs: focus README on safe cache rollouts#89
Draft
lan17 wants to merge 6 commits into
Draft
Conversation
48 tasks
lan17
force-pushed
the
docs/readme-safety-adoption
branch
2 times, most recently
from
July 26, 2026 00:27
3d14c88 to
09d3ee5
Compare
lan17
force-pushed
the
docs/readme-safety-adoption
branch
from
July 26, 2026 03:04
09d3ee5 to
4a2dc71
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cached()or usegetOrLoad()inline; after active layers miss, DialCache calls the application loader and publishes to active request-local, bounded process-local, and optional Redis or Valkey layersdocs/is not included in the package tarballv0.11.0Why
The README on current
mainis technically thorough but makes experienced backend engineers work too hard to establish the basic mental model: What kind of cache is this? What happens on a miss? Which layers does it manage? Which production patterns does it provide, and which infrastructure and safety decisions remain application-owned?The revised README answers those questions before setup. It frames DialCache as read-through caching first, then identifies the production patterns around it: request coalescing, runtime policy, deterministic ramp-up and ramp-down, fail-open reads, targeted invalidation, serialization, deadlines, and backend-neutral metrics. The quick start demonstrates a visible process-local hit, and the production path makes monitored remote rollout explicit.
Impact
This is documentation-only. The branch is based on current
mainatv0.11.0, including the Node.js>=22.0.0runtime floor and dependency-advisory remediation.Merging this PR does not republish
v0.11.0; the rewritten README will appear on npm with a future package release. Its absolute links will resolve to the merged reference guides onmain.Validation
corepack pnpm checkunder Node 22.22.0 — typecheck, 278 unit tests, coverage, builds/declarations, and packed consumerscorepack pnpm test:integration— 73 Redis, Valkey, and Redis Cluster testscorepack pnpm benchmark:request-local— all six semantic scenarios passed, including one-read/one-timer deadline coalescinggit diff --check