json cache

writing

Histograph makes use of a file based cache, easily accessible. for writing cacheable content simply do:

    var helpers = require ('helpers');
    // ...
    helpers.cache.write(contents, {
      namespace: 'services',
      ref: 'Rome, Italy'
    }, function(err) {
      // handle err
    })

First things first: make sure that the settings.paths.cache is correctly set; that the corresponding paths exists and are writable; and that the specific test for the cache mocha -g 'core:cache' does not throw any error (Cfr. mocha documentation for more info about testing with mocha).

The namespace options is compulsory and it define the subfolder where the cached file should be written.

reading

    var helpers = require ('helpers');
    // ...
    helpers.cache.read({
      namespace: 'services',
      ref: 'Rome, Italy'
    }, function (err, contents) {
      // contents variable contains JSON parsed data or raw data if JSON parsing failed
      console.log(contents.results)
      done();
    })

removing

    
    if(settings.paths.cache.services)
      helpers.cache.unlink({
        namespace: 'services',
        ref: 'test'
      }, function (err) {
        // should not exist err
        done();
      })
    else
      done();