Package Exports
- fs-memo
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 (fs-memo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
fs-memo
Easy persisted memo object for Node.js
Usage
Install package:
yarn add fs-memo
# or
or npm install fs-memoconst { getMemo, setMemo } = require('fs-memo')
// or
import { getMemo, setMemo } from 'fs-memo'getMemo(options)
getMemo(options: MemoOptions): Promise<any>Load latest memo from file-system and combine with local state from CJS cache.
FS loading silently bails if:
- The process that made memo is still alive with different pid
- Any fs error happens (like permission denied)
setMemo(options)
setMemo(memo: object, options: MemoOptions): Promise<void>Update local state from CJS cache and persist memo object to file-system.
FS persistence silently bails if any error happens.
Options
dir
Specify directory where memo file should be stored. Default dir is node_modules/.cache/fs-memo
name
Name of memo file. Default name is default (.json is appended to file name)
file
Optionally provide full path to file (discards dir and name options)
License
MIT