Skip to content

Add type definition descriptions#41

Merged
flyingsquirrel0419 merged 1 commit intoMergefrom
docs/type-definitions-39
May 3, 2026
Merged

Add type definition descriptions#41
flyingsquirrel0419 merged 1 commit intoMergefrom
docs/type-definitions-39

Conversation

@flyingsquirrel0419
Copy link
Copy Markdown
Owner

Summary

  • Add JSDoc descriptions to public type definitions so TypeScript language server hover/autocomplete can explain methods and options in editors.
  • Cover core cache entry options, stack options, metrics/result types, layer interfaces, invalidation interfaces, and public helper/integration option surfaces.
  • Add method-level documentation for CacheStack, CacheNamespace, concrete layers, tag indexes, serializers, stampede/single-flight helpers, and integration helpers.

Fixes #39

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing behavior to change)
  • Documentation update
  • Type definition improvement

Testing

  • npm run build
  • npm run lint
  • npm test
  • Verified generated declaration files preserve representative JSDoc comments in dist/*.d.ts and dist/*.d.cts

Notes

  • This is documentation-only at runtime: no implementation behavior was changed.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
layercache-docs Ready Ready Preview, Comment May 2, 2026 0:49am

@flyingsquirrel0419 flyingsquirrel0419 changed the base branch from main to Merge May 3, 2026 04:54
@flyingsquirrel0419 flyingsquirrel0419 merged commit 3e04de2 into Merge May 3, 2026
5 checks passed
@flyingsquirrel0419 flyingsquirrel0419 deleted the docs/type-definitions-39 branch May 3, 2026 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: method and options description in type definitions

1 participant