line_push/node_modules/fs-memo/README.md

fs-memo

Easy persisted memo object for Node.js

Usage

Install package:

yarn add fs-memo
# or
or npm install fs-memo

const { 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(eoptions)

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

interface MemoOptions {
  dir?: string
  name?: string
}

dir

Specify directory where memo file should be stored. Default dir is __dirname (node_modules/fs-memo/dist)

name

Name of memo file. Default name is .fs-memo.

License

MIT