Needlessly Promiscuous, Modularize!
Wondering what’s next for npm?Check out our public roadmap! »

fs-memo
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

fs-memo

Easy persisted memo object for Node.js

npm npm (scoped with tag)

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(optionsMemoOptions)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(memoobject, optionsMemoOptions)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

Keywords

none

Install

npm i fs-memo

DownloadsWeekly Downloads

273,729

Version

1.2.0

License

MIT

Unpacked Size

6.82 kB

Total Files

6

Last publish

Collaborators

  • avatar