cache-manager

What is cache-manager?

The cache-manager npm package is a flexible caching library for Node.js applications, which supports a variety of storage solutions and provides a uniform API to interact with different caching mechanisms. It allows for easy integration and switching between different cache stores without changing the underlying application code.

What are cache-manager's main functionalities?

Caching and Retrieving Data

This feature allows you to cache data in memory and retrieve it using a key. The 'set' method stores the value, and the 'get' method retrieves it. The 'ttl' option specifies the time-to-live in seconds.

{"const cacheManager = require('cache-manager');
const memoryCache = cacheManager.caching({ store: 'memory', max: 100, ttl: 10/*seconds*/ });

// Now set a value
memoryCache.set('myKey', 'myValue', { ttl: 5 }, (err) => {
  if (err) { throw err; }

  // Get the value
  memoryCache.get('myKey', (error, result) => {
    console.log(result);
    // >> 'myValue'
  });
});
}

Cache Store Agnosticism

Cache-manager supports different stores such as memory, Redis, and more. This feature allows you to switch between different cache stores seamlessly. The example shows how to use Redis as the cache store.

{"const cacheManager = require('cache-manager');
const redisStore = require('cache-manager-redis-store');
const redisCache = cacheManager.caching({ store: redisStore, host: 'localhost', port: 6379, auth_pass: 'XXXX', db: 0, ttl: 600 });

// Listen for redis ready event
redisCache.store.events.on('redisReady', () => {
  console.log('Redis is ready');
});

// Listen for redis error event
redisCache.store.events.on('redisError', (error) => {
  console.error('Redis error', error);
});
}

Multi-Level Caching

Cache-manager allows for multi-level caching, where you can have a hierarchy of cache stores. Data is first checked in the fastest cache (e.g., memory), and if not found, it falls back to slower caches (e.g., Redis).

{"const cacheManager = require('cache-manager');
const memoryCache = cacheManager.caching({ store: 'memory', max: 100, ttl: 10 });
const redisCache = cacheManager.caching({ store: require('cache-manager-redis-store'), ttl: 600 });
const multiCache = cacheManager.multiCaching([memoryCache, redisCache]);

multiCache.set('foo', 'bar', { ttl: 5 }, (err) => {
  if (err) { throw err; }

  multiCache.get('foo', (error, result) => {
    console.log(result);
    // >> 'bar'
  });
});
}

Other packages similar to cache-manager

node-cache

node-cache is an in-memory caching package similar to cache-manager's memory store. It offers a simple and fast caching solution but does not support multiple backends or a tiered caching system.

lru-cache

lru-cache is an in-memory cache that implements the LRU (Least Recently Used) eviction policy. Unlike cache-manager, it is specifically tailored for LRU caching and does not support multiple storage backends.

keyv

keyv is a simple key-value storage with support for multiple backends, including Redis, MongoDB, SQLite, and more. It provides a unified interface across different stores but does not have built-in support for multi-level caching.

README

node-cache-manager

Flexible NodeJS cache module

A cache module for nodejs that allows easy wrapping of functions in cache, tiered caches, and a consistent interface.

Features

• Easy way to wrap any function in cache.
• Tiered caches -- data gets stored in each cache and fetched from the highest. priority cache(s) first.
• Use any cache you want, as long as it has the same API.
• 100% test coverage via vitest.

Express.js Example

See the Express.js cache-manager example app to see how to use node-cache-manager in your applications.

Installation

pnpm install cache-manager

Store Engines

• node-cache-manager-redis (uses sol-redis-pool)

• node-cache-manager-redis-store (uses node_redis)

• node-cache-manager-ioredis (uses ioredis)

• node-cache-manager-redis-yet (uses node_redis)

• node-cache-manager-mongodb

• node-cache-manager-mongoose

• node-cache-manager-fs-binary

• node-cache-manager-fs-hash

• node-cache-manager-hazelcast

• node-cache-manager-memcached-store

• node-cache-manager-memory-store

• node-cache-manager-couchbase

• node-cache-manager-sqlite

Contribute

If you would like to contribute to the project, please fork it and send us a pull request. Please add tests for any new features or bug fixes.

License

node-cache-manager is licensed under the MIT license.