From 731bb78872a4b862610add4eda66a38ff530f149 Mon Sep 17 00:00:00 2001 From: Jared Wray Date: Wed, 25 Sep 2024 11:23:19 -0700 Subject: [PATCH 1/2] cache-manager - updating readme with wrap on nonBlocking --- packages/cache-manager/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/cache-manager/README.md b/packages/cache-manager/README.md index f74d5930..edf260d9 100644 --- a/packages/cache-manager/README.md +++ b/packages/cache-manager/README.md @@ -172,6 +172,7 @@ const cache = createCache({ stores: [keyv] }); * `get and mget` - will return the first (fastest) value found. * `del and mdel` - will not wait for all stores to finish. * `clear` - will not wait for all stores to finish. + * `wrap` - will do the same as `get` and `set` (return the first value found and not wait for all stores to finish). ## Methods ### set From 132df2a451571455757022d9810df4b9a4a12c30 Mon Sep 17 00:00:00 2001 From: Jared Wray Date: Wed, 25 Sep 2024 11:26:16 -0700 Subject: [PATCH 2/2] Update README.md --- packages/cache-manager/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/cache-manager/README.md b/packages/cache-manager/README.md index edf260d9..31fe0ab4 100644 --- a/packages/cache-manager/README.md +++ b/packages/cache-manager/README.md @@ -12,6 +12,7 @@ A cache module for NodeJS that allows easy wrapping of functions in cache, tiere - Made with Typescript and compatible with [ESModules](https://nodejs.org/docs/latest-v14.x/api/esm.html). - Easy way to wrap any function in cache, supports a mechanism to refresh expiring cache keys in background. - Tiered caches -- data gets stored in each cache and fetched from the highest priority cache(s) first. +- `nonBlocking` option that optimizes how the system handles multiple stores. - Use with any [Keyv](https://keyv.org/) compatible storage adapter. - 100% test coverage via [vitest](https://github.com/vitest-dev/vitest). @@ -27,6 +28,7 @@ If you are looking for older documentation you can find it here: * [Installation](#installation) * [Quick start](#quick-start) * [Using `CacheableMemory` or `lru-cache` as storage adapter](#using-cacheablememory-or-lru-cache-as-storage-adapter) +* [Options](#options) * [Methods](#methods) * [.set](#set) * [.mset](#mset)