Logo of fs-memo

fs-memo

Node.js 的简易持久化 memo 对象

Node.js 的简易持久化 memo 对象

用法

安装包

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>

从文件系统加载最新的备忘录,并与 CJS 缓存中的本地状态结合。

文件系统加载在以下情况静默失败:

  • 创建备忘录的进程仍在运行,但 PID 不同
  • 发生任何文件系统错误(例如权限被拒绝)

setMemo(options)

setMemo(memo: object, options: MemoOptions): Promise<void>

更新 CJS 缓存中的本地状态,并将备忘录对象持久化到文件系统。

如果发生任何错误,文件系统持久化会静默失败。

选项

dir

指定备忘录文件应存储的目录。默认目录是 node_modules/.cache/fs-memo

name

备忘录文件的名称。默认名称是 default.json 会附加到文件名)

file

可选地提供文件的完整路径(会忽略 dirname 选项)

许可

MIT