node-cache-redis
v6.4.2
Published
Simplistic node redis cache ready can scale with generic-pool support
Downloads
4,313
Maintainers
Readme
node-cache-redis
Simplistic node redis cache ready can scale with generic-pool support
Cache Early; Cache Often
Documentation
Prerequisites
node >= 8
This module requires nodejs v8 or laterredis >= 4
This module requires redis v4 or above as it has dependencies onUNLINK
andredis.replicate_commands()
for pattern deletion.
Featuring
- Works out of the box
- Easy to scale with low friction during locking and purging
- Designed for multithread environment
- Logging can be customized
- Flexible Expiration: Through configuration, you can set a default expiration mode and time for each layer.
- Statistics / Counters: Gather statistical information.
- Modular Design
Migration
4.0.0 contains braking change. See CHANGELOG.md
Getting started
npm install node-cache-redis
Usage
const { init, set, get } = require("node-cache-redis");
init();
// set
await set("key", { "hello": "world" })
const value = await get("key")
API
- init([options]) TSDOC init
options
object properties
Run tests
Using docker
bash test.sh
Run manually
docker run -it -p 6379:6379 redis
npm t
Todo:
- Serialization: Used to serialize values in distributed scenarios and configuration.
- Synchronized locking with a semaphore
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
Sponsors
No sponsors yet! Will you be the first?
Contributors
Amazing people who have contributed code to this project:
- Ron Yang
- Oliver Brooks
Feel free to make changes. Please see the Contributors' Guide for more information on contributing to the documentation.