		# History

		## v2.1.0 2019 January 1

		- Updated [base files](https://github.com/bevry/base) and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)

		## v2.0.0 2018 July 12
		- API updated to use promises instead, as such methods have been renamed to ensure the correct upgrades occur
		- Minimum supported node version is now version 8, due to the usage of async/await

		- API updated to use promises instead, as such methods have been renamed to ensure the correct upgrades occur
		- Minimum supported node version is now version 8, due to the usage of async/await

		## v1.1.0 2016 May 27
		- Updated internal conventions
		- Moved from [ESNextGuardian](https://github.com/bevry/esnextguardian) to [Editions](https://github.com/bevry/editions)

		- Updated internal conventions
		- Moved from [ESNextGuardian](https://github.com/bevry/esnextguardian) to [Editions](https://github.com/bevry/editions)

		## v1.0.1 2015 December 10
		- Updated internal conventions

		- Updated internal conventions

		## v1.0.0 2015 September 5
		- Initial working release

		- Initial working release

149

package.json

		{
		"name": "cachely",
		"version": "2.0.0",
		"version": "2.1.0",
		"description": "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",
		"homepage": "ssh://git@github.com/bevry/cachely",
		"homepage": "https://github.com/bevry/cachely",
		"license": "MIT",
		@@ -21,18 +21,21 @@ "keywords": [
		"patreon",
		"flattr",
		"liberapay",
		"thanksapp",
		"boostlab",
		"buymeacoffee",
		"opencollective",
		"flattr",
		"crypto",
		"paypal",
		"bitcoin",
		"wishlist",
		"---",
		"slackin"
		"wishlist"
		],
		"config": {
		"buymeacoffeeUsername": "balupton",
		"cryptoURL": "https://bevry.me/crypto",
		"flattrUsername": "balupton",
		"liberapayUsername": "bevry",
		"opencollectiveUsername": "bevry",
		"patreonUsername": "bevry",
		"opencollectiveUsername": "bevry",
		"flattrUsername": "balupton",
		"paypalURL": "https://bevry.me/paypal",
		"bitcoinURL": "https://bevry.me/bitcoin",
		"wishlistURL": "https://bevry.me/wishlist",
		"slackinURL": "https://slack.bevry.me"
		"wishlistURL": "https://bevry.me/wishlist"
		}
		@@ -48,7 +51,7 @@ },
		"bugs": {
		"url": "ssh://git@github.com/bevry/cachely/issues"
		"url": "https://github.com/bevry/cachely/issues"
		},
		"repository": {
		"type": "git",
		"url": "ssh://git@github.com/bevry/cachely.git"
		"url": "https://github.com/bevry/cachely.git"
		},
		@@ -60,66 +63,104 @@ "engines": {
		{
		"description": "Source + ESNext + Require",
		"description": "esnext source code with require for modules",
		"directory": "source",
		"entry": "index.js",
		"directory": "source",
		"syntaxes": [
		"tags": [
		"javascript",
		"esnext",
		"require",
		"const",
		"spread",
		"rest",
		"async",
		"promises"
		]
		"require"
		],
		"engines": {
		"node": "8 \|\| 10 \|\| 11",
		"browsers": false
		}
		},
		{
		"description": "Babel Compiled + ES2015 + Require",
		"description": "esnext compiled for browsers with require for modules",
		"directory": "edition-browsers",
		"entry": "index.js",
		"directory": "es2015",
		"syntaxes": [
		"tags": [
		"javascript",
		"es2015",
		"require"
		]
		],
		"engines": {
		"node": false,
		"browsers": "defaults"
		}
		}
		],
		"main": "index.js",
		"browser": "es2015/index.js",
		"main": "source/index.js",
		"browser": "edition-browsers/index.js",
		"dependencies": {
		"editions": "^1.3.4",
		"oneday": "^1.0.0"
		},
		"devDependencies": {
		"assert-helpers": "^4.5.1",
		"babel-cli": "^6.26.0",
		"babel-preset-es2015": "^6.24.1",
		"documentation": "^8.0.0",
		"eslint": "^5.1.0",
		"joe": "^2.0.2",
		"joe-reporter-console": "^2.0.1",
		"projectz": "^1.4.0",
		"@babel/cli": "^7.2.3",
		"@babel/core": "^7.2.2",
		"@babel/plugin-proposal-object-rest-spread": "^7.2.0",
		"@babel/preset-env": "^7.2.3",
		"assert-helpers": "^4.9.3",
		"eslint": "^5.11.1",
		"eslint-config-bevry": "^1.1.1",
		"eslint-config-prettier": "^3.3.0",
		"eslint-plugin-prettier": "^3.0.1",
		"jsdoc": "^3.5.5",
		"kava": "^3.1.0",
		"minami": "^1.2.3",
		"prettier": "^1.15.3",
		"projectz": "^1.7.4",
		"surge": "^0.20.1",
		"typechecker": "^4.5.0"
		"typechecker": "^4.5.0",
		"valid-directory": "^1.0.0"
		},
		"scripts": {
		"our:setup": "npm run our:setup:npm",
		"our:setup:npm": "npm install",
		"our:clean": "rm -Rf ./docs ./es2015 ./es5 ./out",
		"our:compile": "npm run our:compile:es2015",
		"our:compile:es2015": "babel ./source --out-dir ./es2015 --presets es2015",
		"our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
		"our:compile": "npm run our:compile:edition-browsers",
		"our:compile:edition-browsers": "env BABEL_ENV=edition-browsers babel --out-dir ./edition-browsers ./source",
		"our:deploy": "echo no need for this project",
		"our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
		"our:meta:docs": "documentation build -f html -o ./docs -g --shallow ./source/**.js",
		"our:meta:docs": "npm run our:meta:docs:jsdoc",
		"our:meta:docs:jsdoc": "rm -Rf ./docs && jsdoc --recurse --pedantic --access all --destination ./docs --package ./package.json --readme ./README.md --template ./node_modules/minami ./source && mv ./docs/$npm_package_name/$npm_package_version/* ./docs/ && rm -Rf ./docs/$npm_package_name/$npm_package_version",
		"our:meta:projectz": "projectz compile",
		"our:verify": "npm run our:verify:eslint",
		"our:verify:eslint": "eslint --fix ./source",
		"our:deploy": "echo no need for this project",
		"our:test": "npm run our:verify && npm test",
		"our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
		"our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
		"our:release:check-changelog": "cat ./HISTORY.md \| grep v$npm_package_version \|\| (echo add a changelog entry for v$npm_package_version && exit -1)",
		"our:release:check-dirty": "git diff --exit-code",
		"our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
		"our:release:push": "git push origin master && git push origin --tags",
		"our:release:tag": "export MESSAGE=$(cat ./HISTORY.md \| sed -n \"/## v$npm_package_version/,/##/p\" \| sed 's/## //' \| awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" \|\| (echo 'proper changelog entry not found' && exit -1) && git tag v$npm_package_version -am \"$MESSAGE\"",
		"our:release:push": "git push origin master && git push origin --tags",
		"test": "node --harmony ./test.js --joe-reporter=console"
		"our:setup": "npm run our:setup:npm",
		"our:setup:npm": "npm install",
		"our:test": "npm run our:verify && npm test",
		"our:verify": "npm run our:verify:directory && npm run our:verify:eslint",
		"our:verify:directory": "npx valid-directory",
		"our:verify:eslint": "eslint --fix --ignore-pattern '*/.d.ts' --ignore-pattern '/vendor/' --ignore-pattern '/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
		"test": "node ./source/test.js"
		},
		"eslintConfig": {
		"extends": [
		"bevry"
		]
		},
		"prettier": {
		"semi": false,
		"singleQuote": true
		},
		"babel": {
		"env": {
		"edition-browsers": {
		"sourceType": "script",
		"presets": [
		[
		"@babel/preset-env",
		{
		"targets": "defaults",
		"modules": "commonjs"
		}
		]
		],
		"plugins": [
		"@babel/proposal-object-rest-spread"
		]
		}
		}
		}
		}

README.md

		@@ -17,9 +17,11 @@ <!-- TITLE/ -->
		<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
		<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
		<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
		<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/cachely" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
		<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/cachely" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
		<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
		<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
		<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
		<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
		<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
		<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
		<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
		<br class="badge-separator" />
		<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>

		@@ -40,25 +42,36 @@ <!-- /BADGES -->

		<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
		<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
		<ul>
		<li>Install: <code>npm install --save cachely</code></li>
		<li>Module: <code>require('cachely')</code></li></ul>
		<li>Require: <code>require('cachely')</code></li>
		</ul>

		<a href="http://browserify.org" title="Browserify lets you require('modules') in the browser by bundling up all of your dependencies"><h3>Browserify</h3></a><ul>
		<li>Install: <code>npm install --save cachely</code></li>
		<li>Module: <code>require('cachely')</code></li>
		<li>CDN URL: <code>//wzrd.in/bundle/cachely@2.0.0</code></li></ul>
		<a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>

		<a href="http://enderjs.com" title="Ender is a full featured package manager for your browser"><h3>Ender</h3></a><ul>
		<li>Install: <code>ender add cachely</code></li>
		<li>Module: <code>require('cachely')</code></li></ul>
		``` html
		<script type="module">
		import * as pkg from '//dev.jspm.io/cachely'
		</script>
		```

		<h3><a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
		<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>

		<p>This package is published with the following editions:</p>

		<ul><li><code>cachely</code> aliases <code>cachely/index.js</code> which uses <a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
		<li><code>cachely/source/index.js</code> is Source + <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
		<li><code>cachely/es2015/index.js</code> is <a href="https://babeljs.io" title="The compiler for writing next generation JavaScript">Babel</a> Compiled + <a href="http://babeljs.io/docs/plugins/preset-es2015/" title="ECMAScript 2015">ES2015</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>
		<ul><li><code>cachely</code> aliases <code>cachely/source/index.js</code></li>
		<li><code>cachely/source/index.js</code> is esnext source code with require for modules</li>
		<li><code>cachely/edition-browsers/index.js</code> is esnext compiled for browsers with require for modules</li></ul>

		<p>Older environments may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>
		<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>

		This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:

		``` json
		{
		"compilerOptions": {
		"maxNodeModuleJsDepth": 5
		}
		}
		```

		<!-- /INSTALL -->
		@@ -69,2 +82,4 @@

		[API Documentation.](http://master.cachely.bevry.surge.sh/docs/)

		``` javascript
		@@ -150,6 +165,10 @@ let fetches = 0
		<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
		<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
		<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
		<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/cachely" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
		<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/cachely" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
		<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
		<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
		<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
		<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
		<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
		<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
		<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
		@@ -156,0 +175,0 @@

source/index.js

		@@ -12,9 +12,11 @@ 'use strict'
		class Cachely {
		constructor (opts = {}) {
		constructor(opts = {}) {
		this.duration = opts.duration \|\| require('oneday')
		this.log = opts.log \|\| function () { }
		this.log = opts.log \|\| function() {}
		this.retrieve = opts.retrieve

		if (typeof this.retrieve !== 'function') {
		throw new Error('Cachely requires a retrieve method to be specified that returns a promise')
		throw new Error(
		'Cachely requires a retrieve method to be specified that returns a promise'
		)
		}
		@@ -37,3 +39,3 @@
		*/
		static create (...args) {
		static create(...args) {
		return new this(...args)
		@@ -47,4 +49,4 @@ }
		*/
		validate () {
		const nowTime = (new Date()).getTime()
		validate() {
		const nowTime = new Date().getTime()

		@@ -61,3 +63,5 @@ // have we manually invalidated the cache?
		// if the current time, minus the cache duration, is than the last time we retrieved the data, then our cache is invalid
		return new Date(nowTime - this.duration) < this.lastRequested ? 'valid' : 'invalid'
		return new Date(nowTime - this.duration) < this.lastRequested
		? 'valid'
		: 'invalid'
		}
		@@ -83,3 +87,3 @@
		*/
		invalidate () {
		invalidate() {
		this.refresh = true
		@@ -94,3 +98,3 @@ return this
		*/
		async resolve () {
		async resolve() {
		const cache = this.validate()
		@@ -111,4 +115,3 @@ switch (cache) {
		this.lastUpdated = new Date()
		}
		catch (err) {
		} catch (err) {
		this.log('debug', 'Cachely failed to resolve new data')
		@@ -115,0 +118,0 @@ return Promise.reject(err)

es2015/index.js

index.js

cachely - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes