cacheable-data v1.0.3

Cachable

Methods

cacheable(function => Promise) => (function CacheWrapper => Promise)

The cacheable library receives a function, lazily executes it, and caches the data resolved from the function. It returns a function that returns a Promise that resolves to the cached data.

CacheWrapper.refresh = () => Promise

CacheWrapper returned by cacheable method, contains the refresh method, which allows manual trigger to re-run user function and refresh cached data.

Usage

const cacheable = require('cacheable-data')

const cacheWrapper = cacheable(() => {
  // Your custom function to load the data
  // Should return a Promise that resolves to the data to cache
})

// Will only run the custom function once, and return cached data subsequently.
const cachedData = await cacheWrapper()

// Will refresh internal cache.
const refreshedData = await cacheWrapper.refresh()

Example

const cacheable = require('cacheable-data')

const cacheWrapper = cacheable(async () => Date.now())

;(async () => {
  console.log(await cacheWrapper()) // 1522628133629

  console.log(await cacheWrapper()) // 1522628133629

  console.log(await cacheWrapper.refresh()) // 1522628175880

  console.log(await cacheWrapper()) // 1522628175880
})()