Conversation
- Update main README with architecture overview, features, and package table
- Rewrite ts-cache README with complete API documentation:
- Interface definitions (IAsynchronousCacheType, ISynchronousCacheType, etc.)
- Detailed decorator usage (@Cache, @SyncCache, @MultiCache)
- Strategy options and examples
- Custom key strategies (sync and async)
- Advanced usage patterns (deduplication, error handling)
- Update all storage adapter READMEs with:
- Installation instructions
- Usage examples (basic, with options, multi-operations)
- Constructor options and interface definitions
- TTL behavior documentation
- Add IAsyncKeyStrategy to public exports
- Modernize CI/CD:
- Update test.yml to use actions v4, test on Node 18/20/22
- Add publish.yml for automated npm publishing with:
- Release-triggered publishing
- Manual workflow dispatch with version type selection
- Auto-versioning via conventional commits
- Dry-run support
- Remove deprecated .travis.yml
- Remove automatic release triggers (push to master, release events) - Keep only manual workflow_dispatch trigger - Add comprehensive release notes generation: - Lists all published packages with versions - Includes commits since last release - Adds installation instructions - Create GitHub release with gh CLI after npm publish - Add dry-run mode for previewing changes - Add workflow summary for release results - Support prerelease versions with custom identifiers
- Add version_type input with 'auto' as default - Auto mode uses conventional commits to determine version: - fix: → patch - feat: → minor - BREAKING CHANGE → major - Manual override still available (patch/minor/major) - Simplified workflow with only dry_run and version_type inputs
- Add lint script to run ESLint on all source files - Add format script to check Prettier formatting - Update CI workflow to run lint and format checks on PRs - Format check is non-blocking (continue-on-error) due to existing code style
- Format all TypeScript, JavaScript, JSON, and Markdown files - Make Prettier check blocking in CI (no longer continue-on-error)
- Remove debug console.log from RedisStorage constructor - Fix no-promise-executor-return in FsJsonStorage (use block syntax) - Apply auto-fixable lint fixes to multicache.decorator
- Remove Node 18 (EOL April 2024) - Add Node 24 (latest release April 2025) - Keep Node 20 and 22 (current LTS versions)
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
2 participants
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
Documentation Updates
Main README (root)
ts-cache README (main package)
@Cache,@SyncCache,@MultiCache)Storage Adapter READMEs
All 5 storage adapters now have comprehensive docs with installation, examples, options, and interface definitions.
Code Changes
IAsyncKeyStrategyto public exportsCI/CD Updates
Cleanup
.travis.yml