JSPM – cache-point@1.0.0

Package Exports

cache-point

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cache-point) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cache-point

A memoisation solution intended to cache the output of expensive operations, speeding up future invocations with the same input.

Example

const Cache = require('cache-point')
const cache = new Cache({ dir: 'tmp/example' })

// The first invocation will take 3s, the rest instantaneous.
// outputs: 'result'
getData('some input')
  .then(console.log)

// check the cache for output generated with this input.
// cache.read() will resolve on hit, reject on miss.
function getData (input) {
  return cache
    .read(input)
    .catch(() => expensiveOperation(input))
}

// The expensive operation we're aiming to avoid,
// (3 second cost per invocation)
function expensiveOperation (input) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      const output = 'result'
      cache.write(input, output)
      resolve(output)
    }, 3000)
  })
}

cache-point
- Cache ⏏
  - new Cache([options])
  - .dir : string
  - .read(keys) ⇒ Promise
  - .readSync(keys) ⇒ string
  - .write(keys, content) ⇒ Promise
  - .writeSync(keys, content)
  - .getChecksum(keys) ⇒ string
  - .clear() ⇒ Promise
  - .remove() ⇒ Promise

Cache ⏏

Kind: Exported class

new Cache([options])

Param	Type
[options]	`object`
[options.dir]	`string`

cache.dir : `string`

Current cache directory. Can be changed at any time.

Kind: instance property of Cache