simple-redis-cache

1.6.1 • Public • Published

npm version Build Status Coverage Status Dependency Status Gratipay donate button

simple-redis-cache See on Github

Simplistic node redis cache ready can scale with generic-pool support

Cache Early; Cache Often

Prerequisites

node >= 4 This module requires nodejs v4 or above as it has dependencies on es6 components such as Map, Set, Promise etc.

Featuring

  • Out of the box default configuration (but fully configurable)
  • Provides both sync and async API
  • Scalable easily, less friction during locking and purging
  • Synchronized locking with a semaphore
  • Design for multithread environment
  • Extensible Logging
  • Serialization: Used to serialize values in distributed scenarios, can be configured.
  • Flexible Expiration: Through configuration, you can set a default expiration mode and time for each layer.
  • Statistics / Counters: Gather statistical information and track caching operations in Performance Monitor as needed.
  • Modular Design: Lib comes in many different packages, separating the features and dependencies.

Getting started

    npm install simple-redis-cache

Usage

    const RedisCache = require("simple-redis-cache");
    const cache = new RedisCache();

    // set
    cache.set("key", "value");

API

  • RedisCache([options])

options object properties

Name Type Description
name string

Name your store

redisOptions object

opts from node_redis#options-object-properties

poolOptions object

opts from node-pool#createpool

logger object

Inject your custom logger

Run tests

bash test.sh

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?

Patreon donate button Gratipay donate button Flattr donate button

Click here to lend your support to: simple-node-redis-cache and make a donation at pledgie.com !

Contributors

These amazing people have contributed code to this project:

Feel free to make changes. Please see the Contributors' Guide for more information on contributing to the documentation.


---

Package Sidebar

Install

npm i simple-redis-cache

Weekly Downloads

3

Version

1.6.1

License

WTFPL

Last publish

Collaborators

  • pasupulaphani