yet another cache

Why the heck does the world need another caching module? Well, it probably doesn't but while working on http-asset part of me was feeling crazy, part of me was feeling ambitious, and the rest of me was too lazy to sift through all the caching modules on NPM to find the one that best fit the bill.

So, I offer you ya-cache.

features

super simple api
file system backed
cache is just JSON in a file
file system locking ¯\_(ツ)_/¯

example

let Cache = require('ya-cache')
let thingCache = new Cache(join(__dirname, '__cache__'))

const HOUR = 1000 * 60 * 60

let [expires, thing] = thingCache.gets('expire', 'thing')
if (expires && expires < Date.now()) {
  thing = await calculateComplexThingy()
  await thingCache.sets({
    expire: Date.now() + 24 * HOUR
    thing: thing
  })
}

doSomethingWithThing(thing)

api

`new Cache(path, lockFileOptions = {})`

Constructs a cache object, provides the api to each cache

`cache.get([key]) -> Promise`

Get the value of a key, returns a promise. If the key argument is undefined then all keys and their values are returned in an object.

cache.get('key').then(function (val) {
  console.log('value for key is', val)
})

`cache.set(key, val) -> Promise`

Set the value of a key, returns a promise.

cache.set('key', 'value').then(function () {
  console.log('value for %s is now set to %s', 'key', 'value')
})

`cache.gets(...keys) -> Promise`

Get one or more keys, returns a promise that resolves to an array of values.

cache.gets('key1', 'key2', 'key3').then(function (vals) {
  vals.forEach(function (val, i) {
    console.log('key%i has value %s', i + 1, val)
  })
})

`cache.sets({ key: value ... }) -> Promise`

Set one of more keys, returns a promise that resolves to an object of the saved values.

cache.sets({
  key1: 'foo'
  key2: 'bar'
  key3: 'baz'
}).then(function (vals) {
  console.log('saved vals', vals)
})

`cache.clear([key]) -> Promise`

Clear a key in the cache. If the key is undefined then all keys are cleared

cache.set('foo', 'bar')
cache.clear('foo')
cache.get('foo').then(function (val) {
  console.log('foo equals "%s"', val) // foo equals "undefined"
})

Current Tags

1.0.1 ... latest (9 years ago)

5 Versions

1.0.1 ... 9 years ago
1.0.0 ... 9 years ago
1.0.0-alpha.2 ... 9 years ago
1.0.0-alpha.1 ... 9 years ago
1.0.0-alpha ... 9 years ago