Redis standalone caching library for Node.JS and also cache engine for Cacheman
npm install recacheman-redis> This is a fork version of cacheman-redis
!License
!NPM download/month
!NPM download total
Redis standalone caching library for Node.JS and also cache engine for recacheman.
| Version | Redis Library | Node.JS |
|---|---|---|
| 2.x | 3.x | 10, 12 |
| 3.x | 4.x | 14, 16, 18 , 20 |
| 4.x | 5.x | 20, 22 |
`` bash`
$ npm install recacheman-redis
`javascript
var CachemanRedis = require('recacheman-redis');
var cache = new CachemanRedis();
// set the value
cache.set('my key', { foo: 'bar' }, function (error) {
if (error) throw error;
// get the value
cache.get('my key', function (error, value) {
if (error) throw error;
console.log(value); //-> {foo:"bar"}
// delete entry
cache.del('my key', function (error){
if (error) throw error;
console.log('value deleted');
});
});
});
`
Create cacheman-redis instance. options are redis valid options including port and host.
Note:
- Since Redis 4.x actualy they're removed port and host property options, but I still keep support it in this library.
- For more details, please see here >> Redis Client Configuration Options.
`javascript
var options = {
port: 9999,
host: '127.0.0.1',
password: 'my-p@ssw0rd'
database: 1
};
var cache = new CachemanRedis(options);
`
You can also pass a redis connection string as first arguments like this:
`javascript`
var cache = new CachemanRedis('redis://127.0.0.1:6379');
Or pass a redis connection string as object like this:
`javascript`
var cache new CachemanRedis({ url: 'redis://localhost:6379'})
Or pass a redis client instance directly as client:
`javascript
var client = redis.createClient();
var cache = new CachemanRedis(client);
// or
cache = new CachemanRedis({ client: client });
`
Or pass a redis client directly with connection uri:`javascript`
var cache = new CachemanRedis({ client: 'redis://localhost:6379' });
Stores or updates a value.
`javascript`
cache.set('foo', { a: 'bar' }, function (err, value) {
if (err) throw err;
console.log(value); //-> {a:'bar'}
});
Or add a TTL(Time To Live) in seconds like this:
`javascript`
// key will expire in 60 seconds
cache.set('foo', { a: 'bar' }, 60, function (err, value) {
if (err) throw err;
console.log(value); //-> {a:'bar'}
});
Retrieves a value for a given key, if there is no value for the given key a null value will be returned.
`javascript`
cache.get(function (err, value) {
if (err) throw err;
console.log(value);
});
Deletes a key out of the cache.
`javascript`
cache.del('foo', function (err) {
if (err) throw err;
// foo was deleted
});
Clear the cache entirely, throwing away all values.
`javascript`
cache.clear(function (err) {
if (err) throw err;
// cache is now clear
});
Scan cache from a cursor point and return a count of values
`javascript``
cache.set('foo', { a: 'bar' }, 10, function (err) {
cache.scan(0, 10, function (err, result) {
console.log(result) // { cursor: 0, entries: [{ key: 'foo', data: { a: 'bar' } }] }
});
});
`
npm test
(The MIT License)
Copyright (c) 2014 Jonathan Brumley <cayasso@gmail.com>,
M Abd Aziz Alfian <aalfiann@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.