Skip to content

README.md

Latest commit

 

History

History
92 lines (66 loc) · 2.92 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.92 KB
Raw

Build Status Dependency Status devDependency Status

Caching Layer for Node-GitHub

This is a Node.JS module that transparently adds caching for the node-github project.

Using the default leveldb for caching works completely. Consul Key/Value storage has been tested a little and seems to work just fine.

Installation

Install with Node.JS package manager

$ npm install github-cache

Documentation

You use this class just like you would use node-github.

If you want to not use the cache at any time, add cache: false to your API call.

Settings

  1. cachedb - this is a value passed to the creation of the API object, it is a path to a location to store the cached data or it can be a leveldb instance or ANY object that has del, put, and get functions.
  2. cache - this is a value that can be passed to any API function with a boolean value to disable or enable the cache. Default: true
  3. validateCache - Default: true - Check cached etag using If-None-Match with GitHub API before using the cached data. Ensures you have the latest data at all times. Setting to false allows you to use cached data without making the API call, results in quicker lookups. Especially useful if you are making dozens of API calls or more.
  4. prefix - Default: '' - this will prefix all keys in the key/value storage system
  5. separator - Default: : - this will separate the various layers of key

Example

Using LevelDB

var GitHubApi = require("github-cache");

var github = new GitHubApi({
  version: "3.0.0",
  debug: true,
  cachedb: './cachedb',
  validateCache: true
});

github.user.getFollowingFromUser({
  user: "ekristen",
  cache: false
}, function(err, res) {
  console.log(JSON.stringify(res));
});

github.orgs.getTeams({
  org: 'private',
  validateCache: false
}, function(err, teams) {
  console.log(teams);
});

Example using Consul

var GitHubAPI = require('./cache')
var consul = require('consul')({
  host: '127.0.0.1'
})

// Need to make the set function available as `put` for the cache library to work.
consul.kv.put = consul.kv.set

// You will want to use a prefix and a `/` separator so that they keys get separated out better in consul.
var github = new GitHubAPI({
  version: "3.0.0",
  cachedb: consul.kv,
  prefix: 'github-cache',
  separator: '/'
});

github.authenticate({
  type: 'oauth',
  token: process.env.GHTOKEN
});

github.user.getFollowingFromUser({
  user: "ekristen",
}, function(err, data) {
  console.log(data)
});