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
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
example.js
index.js
package-lock.json
package.json
test.js

README.md

cachely

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

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@2.0.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

API Documentation.

let fetches = 0
const cachely = require('cachely').create({
    // The method that will fetch the data
    retrieve () {
        return new Promise(function (resolve) {
            // after a one second delay, return the number of fetches that we have done
            setTimeout(() => resolve(++fetches), 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 dat
cachely.resolve().catch(console.error).then(console.log.bind(console, 'after one second as specified in our method, the result data should still be 1:'))

// do a subsequent fetch of the data that will be from the cach
cachely.resolve().catch(console.error).then(console.log.bind(console, 'after a tiny delay this will be from cache, the result data should still be 1:'))

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

    // do a subsequent fetch of the data that will be from the cache
    cachely.resolve().catch(console.error).then(console.log.bind(console, 'after a tiny delay this will be from cache, the result data should still be 2:'))

    // peform a manual invalidation
    cachely.invalidate()

    // do a third fetch of the data
    cachely.resolve().catch(console.error).then(console.log.bind(console, 'after one second as specified in our method, the result data should be 3, as it was our third fetch:'))

    // do a subsequent fetch of the data that will be from the cache
    cachely.resolve().catch(console.error).then(console.log.bind(console, 'after a tiny delay this will be from cache, the result data should still be 3:'))
}, 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:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

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

License

Unless stated otherwise all works are:

and licensed under: