JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9
  • Score
    100M100P100Q39930F
  • License WTFPL

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

Package Exports

  • node-cache-redis-fork

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-cache-redis-fork) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm version Build Status Coverage Status Dependency Status

node-cache-redis 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. redis >= 4 This module requires redis v4 or above as it has dependencies on UNLINK and redis.replicate_commands() for pattern deletion.

Featuring

  • Out of the box default configuration (but fully configurable)
  • Scalable easily, less friction during locking and purging
  • Design for multithread environment
  • Extensible Logging
  • 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.
Todo:
  • Serialization: Used to serialize values in distributed scenarios, can be configured.
  • Synchronized locking with a semaphore
  • Provides both sync and async API

Getting started

    npm install node-cache-redis

Usage

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

    // set
    cache.set("key", "value")
    .then(function () {
      return cache.get("key");
    })
    .then(function (value) {
      assert.eql(value, "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

ttlInSeconds number

Default time to live for stored values

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.