https://github.com/rjsaran/multicache
Multiple object cache for NodeJS
https://github.com/rjsaran/multicache
cache nodejs object-cache
Last synced: 4 months ago
JSON representation
Multiple object cache for NodeJS
- Host: GitHub
- URL: https://github.com/rjsaran/multicache
- Owner: rjsaran
- Created: 2017-11-03T19:09:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-23T07:22:47.000Z (about 6 years ago)
- Last Synced: 2025-06-09T20:09:47.526Z (8 months ago)
- Topics: cache, nodejs, object-cache
- Language: JavaScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
MultiCache
=======
MultiCache is an Multiple Object caching module for node.js. Objects are cached via a backing store.
(Inspired by [obcache](https://github.com/qzaidi/obcache))
Currently 2 stores are supported.
- Memory
- Redis
Multicache First check for each item in cache parallely, Than do only one single call to fetch data from underlying datastore for which no data is present in cache. Respond with data from both Cache and Main data store merged.
Usage
-----
```
const Cache = require('./lib/cache');
// Create a Redis cache
const cache = new Cache('redis', {port: 6379, host: '127.0.0.1'});
```
To cache response of a function:
1) Wrap original function like below
```
var wrapper = cache.wrap(original);
```
2) Now call the wrapped function
```
wrapper(arg1,arg2...argn,function(err,res) {
if (!err) {
// do something with res
}
});
```
API
---
### cache.wrap
Wraps a given function and returns a cached version of it.
Functions to be wrapped must have a callback function as the last argument. The callback function is expected to recieve 2 arguments - err and data. data gets stored in the cache.
The first n-1 arguments are used to create the key. Subsequently, when the wrapped function is called with the same n arguments, it would lookup the key in cache, and if found, call the callback with the associated data.
Notes:
In case of memory store, It is expected that the callback will never modified the returned data, as any modifications of the original will change the object in cache.
Lets Say input ids are : [123, 143];
Response of orignal function should always be:
```
{
123: {},
143: {}
}
```
Memory Store:
| Key | Type | Description |
|:-------------:|:-------------:| :---------------------:|
| max | Integer | Maximum no of keys in LRU store|
| maxAge | Integer | TTL in miliseconds |
Redis Store:
| Key | Type | Description | Default |
|:-------------:|:-------------:| :---------------------:|:--------:|
| maxAge | Integer | TTL in miliseconds | 60 Seconds|
| db | Integer | Redis Server DB | 0 |
| prefix | String | Prefix to be used for redis key| mbc: |
| twemproxy | Boolean | Redis server is behind twemproxy or not| false |
| host | String | Redis Host | 127.0.0.1 |
| port | Integer | Redis Port | 6379 |