fs-memo

> Easy persisted memo object for Node.js


Usage

Install package:

``bash
yarn add fs-memo


or


or npm install fs-memo
`

`js
const { getMemo, setMemo } = require('fs-memo')
// or
import { getMemo, setMemo } from 'fs-memo'
`




$3

`ts
getMemo(options: MemoOptions): Promise
`

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)

$3

`ts
setMemo(memo: object, options: MemoOptions): Promise
`

Update local state from CJS cache and persist memo object to file-system.

FS persistence silently bails if any error happens.

Options

$3

Specify directory where memo file should be stored. Default dir is node_modules/.cache/fs-memo

$3

Name of memo file. Default name is default (.json is appended to file name)

$3

Optionally provide full path to file (discards dir and name` options)

License

MIT