2024-04-29

What's Changed

• redis - upgrading vitest to 1.4.0 by @jaredwray in #660
• redis - updating cache-manager to 5.5.1 by @jaredwray in #661
• redis - upgrading typescript to 5.4.4 by @jaredwray in #662
• Fix broken links in README by @turastory in #663
• fixing the xo runner on test:ci by @jaredwray in #664
• fix docs by @corradodellorusso in #668
• cache-manager - upgrading typescript and types to latest by @jaredwray in #670
• upgrading lru-cache to 10.2.2 by @jaredwray in #671
• cache-manager - upgrading vitest to 1.5.2 by @jaredwray in #672
• ioredis-yet - upgrading typescript to 5.4.5 by @jaredwray in #673
• ioredis-yet - upgrading eslint to 9.1.1 by @jaredwray in #674
• ioredis-yet - upgrading ioredis to 5.4.1 by @jaredwray in #675
• ioredis-yet - upgrading vitest to 1.5.2 by @jaredwray in #676
• redis-yet - upgrading typescript to 5.4.5 by @jaredwray in #677
• redis-yet - upgrading eslint to 9.1.1 by @jaredwray in #678
• redis-yet - upgrading vitest to 1.5.2 by @jaredwray in #679

New Contributors

• @turastory made their first contribution in #663
• @corradodellorusso made their first contribution in #668

Full Changelog: 2024-04-05...2024-04-29

2024-04-05

Migration to new Mono Repo

We have migrated to the new mono repo and have included all packages from node-cache-manager. We will be shutting down the github org and legacy repos in the next 30 days (May 5th). All issues should be here moving forward. In addition to the mono repo there are some changes:

• cache-manager-redis-yet - this has a breaking change of support from nodejs v16 to 18+

What's Changed

• Update README.md by @jaredwray in #655
• initial mono repo changes by @jaredwray in #656
• migrating to a mono repo - redis by @jaredwray in #657
• updating readme with new path by @jaredwray in #658
• adding in two redis servers for testing by @jaredwray in #659

Full Changelog: v5.5.0...2024-04-05

v5.5.0

Added Event Errors

Cache Manager now does not throw errors by default. Instead, all errors are evented through the error event. Here is an example on how to use it:

const memoryCache = await caching('memory', {
  max: 100,
  ttl: 10 * 1000 /*milliseconds*/,
});
memoryCache.on('error', (error) => {
  console.error('Cache error:', error);
});

What's Changed

• Adding SQLite storage(use better-sqlite3) by @huijiewei in #638
• Ability to catch promise rejections from background refreshes by @Kauhsa in #637
• updating readme to show configuration options by @jaredwray in #644
• updating readme with correct settings on shouldCloneBeforeSet by @jaredwray in #645
• Fix README: missing closing of code block by @tdelmas in #648
• updating contributing guidelines by @jaredwray in #649
• moving templates and repo paths to cache-manager by @jaredwray in #650
• updating readme to correct paths by @jaredwray in #651
• removing dotenv-cli as it is not used by @jaredwray in #652
• Migrating to xo for linting by @jaredwray in #653
• Add onCacheError option by @slukes in #646
• updating documentation and version by @jaredwray in #654

New Contributors

• @huijiewei made their first contribution in #638
• @Kauhsa made their first contribution in #637
• @tdelmas made their first contribution in #648
• @slukes made their first contribution in #646

Full Changelog: v5.4.0...v5.5.0

v5.4.0

Refresh cache keys in background

Both the caching and multicaching modules support a mechanism to refresh expiring cache keys in background when using the wrap function.
This is done by adding a refreshThreshold attribute while creating the caching store or passing it to the wrap function.

If refreshThreshold is set and after retrieving a value from cache the TTL will be checked.
If the remaining TTL is less than refreshThreshold, the system will update the value asynchronously,
following same rules as standard fetching. In the meantime, the system will return the old value until expiration.

What's Changed

• Add refreshThreshold as parameter of wrap function. Fix #606 by @lchenay in #630
• upgrading vitest to 1.2.1 by @jaredwray in #634
• updating eslint and prettier to latest by @jaredwray in #635
• fixing multi-cache testing of ttl wrap function by @jaredwray in #636

Full Changelog: v5.3.2...v5.4.0

v5.3.2

What's Changed

• Use a github action workflow to release new versions by @QuentinLemCode in #612
• adding in prepare for the build by @jaredwray in #618
• fix: exclude sourcemap when package publish by @czy88840616 in #622
• updating clean to scripts by @jaredwray in #623
• feat: support sync cache creation by @denkan in #598
• 619: Ensure that background refresh only calls fn once. by @ricall in #620
• updating typescript and removing release workflow by @jaredwray in #624
• updating vitest to 1.1.0 by @jaredwray in #625
• upgrading promise-coalesce to 1.1.2 by @jaredwray in #626
• upgrading lru-cache to 10.1.0 by @jaredwray in #627
• upgrading typescript and eslint to latest by @jaredwray in #628

New Contributors

• @QuentinLemCode made their first contribution in #612
• @czy88840616 made their first contribution in #622
• @denkan made their first contribution in #598
• @ricall made their first contribution in #620

Full Changelog: v5.3.0...v5.3.2

v5.3.1

Major fix as 5.3.0 did not have the dist folder on release.

What's Changed

• updating to always run vitest with coverage by @jaredwray in #605
• fix(refreshThreshold): don't run if ttl is -1 by @mihirgupta0900 in #604
• fix(caching): coalesce concurrent requests to wrap function by @douglascayers in #599
• upgrading lru-cache to 10.0.2 by @jaredwray in #609
• upgrading eslint, prettier, and types to latest by @jaredwray in #610

New Contributors

• @mihirgupta0900 made their first contribution in #604
• @douglascayers made their first contribution in #599

Full Changelog: 5.2.4...v5.3.1

v5.3.0

What's Changed

• updating to always run vitest with coverage by @jaredwray in #605
• fix(refreshThreshold): don't run if ttl is -1 by @mihirgupta0900 in #604
• fix(caching): coalesce concurrent requests to wrap function by @douglascayers in #599
• upgrading lru-cache to 10.0.2 by @jaredwray in #609
• upgrading eslint, prettier, and types to latest by @jaredwray in #610

New Contributors

• @mihirgupta0900 made their first contribution in #604
• @douglascayers made their first contribution in #599

Full Changelog: 5.2.4...v5.3.0

5.2.4

Updates 🍻

• Added refreshing cache keys in the background. You can learn more here: https://github.com/node-cache-manager/node-cache-manager#refresh-cache-keys-in-background - #586
• Enabling the ttl of a wrap to be a function async <T>(key: string, fn: () => Promise<T>, ttl?: WrapTTL<T>) - #535

What's Changed

• fix(deps): update dependency lru-cache to v10 by @renovate in #500
• chore(deps): update vitest monorepo to v0.32.2 by @renovate in #490
• chore(deps): update dependency eslint to v8.43.0 by @renovate in #501
• chore(deps): lock file maintenance by @renovate in #502
• chore(deps): update typescript-eslint monorepo to v5.60.0 by @renovate in #503
• chore(deps): update commitlint monorepo to v17.6.6 by @renovate in #505
• chore(deps): lock file maintenance by @renovate in #506
• chore(deps): update typescript-eslint monorepo to v5.60.1 by @renovate in #507
• chore(deps): update dependency @types/node to v20.3.2 by @renovate in #508
• chore(deps): update dependency typescript to v5.1.5 by @renovate in #509
• chore(deps): update dependency lint-staged to v13.2.3 by @renovate in #510
• chore(deps): update dependency typescript to v5.1.6 by @renovate in #511
• chore(deps): update dependency @types/node to v20.3.3 by @renovate in #513
• chore(deps): update dependency eslint to v8.44.0 by @renovate in #514
• chore(deps): lock file maintenance by @renovate in #515
• chore(deps): update vitest monorepo to v0.32.4 by @renovate in #516
• chore(deps): update typescript-eslint monorepo to v5.61.0 by @renovate in #517
• chore(deps): update dependency @release-it/conventional-changelog to v6 by @renovate in #518
• chore(deps): update dependency @types/node to v20.4.0 by @renovate in #520
• chore(deps): update dependency release-it to v16 by @renovate in #521
• chore(deps): update dependency @vitest/coverage-v8 to v0.33.0 by @renovate in #523
• chore(deps): update dependency vitest to v0.33.0 by @renovate in #524
• chore(deps): update dependency @types/node to v20.4.1 by @renovate in #525
• chore(deps): update dependency release-it to v16.1.0 by @renovate in #526
• chore(deps): update dependency @release-it/conventional-changelog to v7 by @renovate in #527
• chore(deps): lock file maintenance by @renovate in #528
• chore(deps): update typescript-eslint monorepo to v5.62.0 by @renovate in #529
• chore(deps): update dependency @types/node to v20.4.2 by @renovate in #534
• chore(deps): update dependency eslint to v8.45.0 by @renovate in #536
• feat: the ttl of wrap could be function by @peng-huang-ch in #535
• chore(deps): update typescript-eslint monorepo to v6 (major) by @renovate in #530
• chore(deps): update dependency release-it to v16.1.2 by @renovate in #537
• chore(deps): lock file maintenance by @renovate in #538
• chore(deps): update typescript-eslint monorepo to v6.1.0 by @renovate in #539
• chore(deps): update commitlint monorepo to v17.6.7 by @renovate in #540
• chore(deps): update dependency release-it to v16.1.3 by @renovate in #541
• chore(deps): update dependency @types/node to v20.4.3 by @renovate in #542
• chore(deps): update dependency @types/node to v20.4.4 by @renovate in #543
• chore(deps): lock file maintenance by @renovate in #544
• chore(deps): update typescript-eslint monorepo to v6.2.0 by @renovate in #545
• chore(deps): update pnpm/action-setup action to v2.3.0 by @renovate in #546
• chore(deps): update dependency @types/node to v20.4.5 by @renovate in #547
• chore(deps): update pnpm/action-setup action to v2.4.0 by @renovate in #548
• chore(deps): update dependency eslint-config-prettier to v8.9.0 by @renovate in #549
• chore(deps): update dependency eslint to v8.46.0 by @renovate in #550
• chore(deps): update dependency @types/node to v20.4.6 by @renovate in #554
• chore(deps): update dependency eslint-config-prettier to v8.10.0 by @renovate in #555
• chore(deps): update dependency @types/node to v20.4.7 by @renovate in #556
• chore(deps): update dependency @types/node to v20.4.8 by @renovate in #557
• chore(deps): update dependency eslint-config-prettier to v9 by @renovate in #558
• chore(deps): update dependency @types/node to v20.4.9 by @renovate in #559
• chore(deps): update commitlint monorepo to v17.7.0 by @renovate in #560
• chore(deps): update dependency release-it to v16.1.4 by @renovate in #561
• chore(deps): update dependency @commitlint/cli to v17.7.1 by @renovate in #562
• chore(deps): update dependency eslint to v8.47.0 by @renovate in #563
• chore(deps): update dependency @types/node to v20.4.10 by @renovate in #564
• chore(deps): update dependency release-it to v16.1.5 by @renovate in #565
• chore(deps): update dependency lint-staged to v13.3.0 by @renovate in #566
• chore(deps): update dependency @types/node to v20.5.0 by @renovate in #567
• chore(deps): update dependency lint-staged to v14 by @renovate in #568
• chore(deps): update dependency dotenv-cli to v7.3.0 by @renovate in #569
• chore(deps): update dependency @types/node to v20.5.1 by @renovate in #570
• chore(deps): update dependency lint-staged to v14.0.1 by @renovate in #571
• chore(deps): update dependency @types/node to v20.5.2 by @renovate in #572
• chore(deps): update dependency @types/node to v20.5.3 by @renovate in #574
• chore(deps): update dependency @types/node to v20.5.4 by @renovate in #575
• chore(deps): update dependency @types/node to v20.5.5 by @renovate in #578
• chore(deps): update dependency @types/node to v20.5.6 by @renovate in #579
• chore(deps): update dependency eslint to v8.48.0 by @renovate in #580
• chore(deps): update dependency @types/node to v20.5.7 by @...

Release 5.2.3

5.2.3 (2023-06-14)

Bug Fixes

• minor issues (920c17f)
• update dependencies (d0b3583)

Release 5.2.2

5.2.2 (2023-05-29)

Bug Fixes

• sizeCalculation key,value swap (#480) (0dde805)