cachely

cachely

A tiny wrapper that sits around your request function that caches its data for a specified duration, provides updates as requested rather than polling each interval

Install

NPM

• Install: npm install --save cachely
• Module: require('cachely')

Browserify

• Install: npm install --save cachely
• Module: require('cachely')
• CDN URL: //wzrd.in/bundle/cachely@1.1.0

Ender

• Install: ender add cachely
• Module: require('cachely')

Editions

This package is published with the following editions:

• cachely aliases cachely/index.js which uses Editions to automatically select the correct edition for the consumers environment
• cachely/source/index.js is Source + ESNext + Require
• cachely/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

let fetches = 0
const cachely = require('cachely').create({
	// The method that will fetch the data
	// It receives one argument which is a completion callback that accepts two arguments (err and data)
	method: function (next) {
		// in this case, after a one second delay, return the number of fetches that we have done
		setTimeout(function () {
			next(null, ++fetches)  // err, data
		}, 1000)
	},

	// An optional duration in milliseconds that our cache of the data will be valid for
	// When expired, on the next request of the data, we will use the method to get the latest data
	// Defaults to one day
	duration: 2000,  // in this example we set it to two seconds

	// An optional function that receives debugging log messages
	// Defaults to nothing
	log: console.log
})

// do an initial fetch of the data
cachely.request(function (err, data) {
	console.log('after one second as specified in our method, the result data should still be 1:', data, err)
})

// do a subsequent fetch of the data that will be from the cache
cachely.request(function (err, data) {
	console.log('after a tiny delay this will be from cache, the result data should still be 1:', data, err)
})

// wait for the cache to invalidate itself
setTimeout(function () {
	// do an second fetch of the data
	cachely.request(function (err, data) {
		console.log('after one second as specified in our method, the result data should be 2, as it was our second fetch:', data, err)
	})

	// do a subsequent fetch of the data that will be from the cache
	cachely.request(function (err, data) {
		console.log('after a tiny delay this will be from cache, the result data should still be 2:', data, err)
	})

	// peform a manual invalidation
	cachely.invalidate()

	// do a third fetch of the data
	cachely.request(function (err, data) {
		console.log('after one second as specified in our method, the result data should be 3, as it was our third fetch:', data, err)
	})

	// do a subsequent fetch of the data that will be from the cache
	cachely.request(function (err, data) {
		console.log('after a tiny delay this will be from cache, the result data should still be 3:', data, err)
	})
}, 3000)

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton
• Benjamin Lupton — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2015+ Bevry Pty Ltd

and licensed under:

• MIT License

Changelog

v1.1.0 2016 May 27

• Updated internal conventions
  • Moved from ESNextGuardian to Editions