yield-cache

Cache utility for generator

plover \ node | 5.x | 4.x | 0.12.x --- | --- | --- | ---- 0.x.x | √ | √ | √ 1.x.x | √ | √ | X

$ npm install yield-cache

API

yieldCache()

create cache instance

var cache = yieldCache();

cache(key, obj)

try get item from cache or yeild from obj

cache.remove(key)

remove cache item for key

Useage

1. Create an instance for cache a group of generator

var cache = yieldCache();

2. Use cache instance

// it should used in generator function
function* () {
  // call with cackeKey and yieldable object
  var item = yield* cache(cacheKey, Generator or GeneratorFunction or Functin that return Promise);
}

Example

var yieldCache = require('yield-cache');


// create an instance
var renderCache = yieldCache();


// use
function* getRender(path) {
  var render = yield* renderCache(path, function* () {
    var tpl = yield fs.readFile(path, 'utf-8');
    return compiler.complie(tpl);
  });

  return render;
}


var path = ...
var render = yield* getRender(path);
var render2 = yield* getRender(path);

render.should.equal(render2);