cacheman-memory


In-memory caching library for Node.JS and also cache engine for cacheman.

Instalation

`` bash
$ npm install cacheman-memory
`

Usage

`javascript
var CachemanMemory = require('cacheman-memory');
var cache = new CachemanMemory();

// 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');
});

});
});
`

API

$3

Create cacheman-memory instance.

`javascript
var cache = new CachemanMemory();
`

$3

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'}
});
`

$3

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);
});
`

$3

Deletes a key out of the cache.

`javascript
cache.del('foo', function (err) {
if (err) throw err;
// foo was deleted
});
`

$3

Clear the cache entirely, throwing away all values.

`javascript
cache.clear(function (err) {
if (err) throw err;
// cache is now clear
});
`

$3

Get all keys and entries in cache

`javascript
cache.set('foo', { a: 'bar' }, 60, function (err, value) {
if (err) throw err;
cache.getAll(function (err, data) {
if (err) throw err;
// [{ key: 'foo', data: { a: 'bar' } }]
});
`

Run tests

` bash
$ make test
``

License

(The MIT License)

Copyright (c) 2013 Jonathan Brumley <cayasso@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.