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
• Require: require('cachely')

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/cachely'
</script>

Editions

This package is published with the following editions:

• cachely aliases cachely/source/index.js
• cachely/source/index.js is esnext source code with require for modules
• cachely/edition-browsers/index.js is esnext compiled for browsers with require for modules

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

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:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• 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

v2.1.0 2019 January 1

• Updated base files and editions using boundation