sync-disk-cache
A sync disk cache. inspired by jgable/cache-swap
An async sibling version is also available: stefanpenner/async-disk-cache
By default, this will usge TMPDIR/<username>/
for storage, but this can be changed by setting the $TMPDIR
environment variable.
All stored values become strings.
Example
var Cache = require('sync-disk-cache');
var cache = new Cache('my-cache');
cache.has('foo') === wasFooFound;
cache.get('foo') === {
isCached: true,
path: 'foo',
content: 'content of foo'
}
cache.get('foo') === {
isCached: false,
path: 'foo',
content: undefined
}
cache.set('foo', 'content of foo');
cache.remove('foo');
cache.clear();
Enable compression:
note: node 0.10.x does not support the synchronous zlib method variants, so compression is only available > 0.10.x
var Cache = require('sync-disk-cache');
var cache = new Cache('my-cache', {
compression: 'gzip' | 'deflate' | 'deflateRaw'
})
License
Licensed under the MIT License, Copyright 2015 Stefan Penner