persistable v0.1.2

Persistable

Callback caching

persistable stores the return value of a callback on disk and returns it on subsequent calls.

Installation

npm install persistable

Usage

require('persitable')(/* options */)(Math.random)

Basic example

const persistable = require('persitable')

const persist = persistable(/* options */)

const value1 = persist(Math.random)
const value2 = persist(Math.random)

console.log(value1 === value2) // true

Advanced example

const persistable = require('persitable')

const persist = persistable({ outputDir: 'data' })

const value1 = persist(Math.random)
const value2 = persist(Math.random)
const value3 = persist(Math.random, true) // refresh on 2nd param
const value4 = persist(Math.random)

console.log(value1 === value2) // true
console.log(value2 != value3) // true
console.log(value3 === value4) // true

API

Table of Contents

• PersistFn
  • Parameters
• Persistable
  • Parameters
• Options
  • Properties

PersistFn

Type: Function

Parameters

• callback function callback to be persisted
• refresh boolean call the callback (optional, default false)
• name string? defaults to hashed callback

Persistable

Creates new instance of persistable

Type: Function

Parameters

• options Partial<Options>?

Returns Persist

Options

Type: object

Properties

• outputDir string? location to save persisted return values
• minify boolean? inline JSON objects