Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cache-manager - updating readme with wrap on nonBlocking #802

Merged
merged 2 commits into from
Sep 25, 2024
Merged

cache-manager - updating readme with wrap on nonBlocking #802

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
731bb78
cache-manager - updating readme with wrap on nonBlocking
jaredwray Sep 25, 2024
132df2a
Update README.md
jaredwray Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/cache-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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)
Expand Down Expand Up @@ -172,6 +174,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
Expand Down
Loading