persist-node-fs

星标4

分支0

更新时间2026年7月23日 07:05

Persist to the filesystem with @stainless-code/persist/backends/node-fs (nodeFsStateStorage). StateStorage only — compose createStorage + codec; one file per key with hash suffix.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

来源

stainless-code

stainless-code/persist

打开 GitHub 仓库查看创作者相关仓库

下载

Node filesystem backend

Exports nodeFsStateStorage({ dir }) only — compose with createStorage + a codec. One file per key; sanitized name + djb2 hash suffix (collision-safe). Refuses keys that sanitize to . / .. / "". ENOENT → null / no-op remove.

Minimal wiring

import { createStorage, jsonCodec } from "@stainless-code/persist";
import { nodeFsStateStorage } from "@stainless-code/persist/backends/node-fs";

const storage = createStorage<Prefs>(
  () => nodeFsStateStorage({ dir: "./.persist" }),
  jsonCodec(),
);

No optional peer for this backend — uses node:fs. Richer graphs → persist-seroval as the codec.

Common mistakes

Expecting a create*Storage PersistStorage factory.
Assuming sanitize alone makes unique paths — the hash suffix is required for collisions.
Path-traversal keys — refused after sanitize.

API surface

nodeFsStateStorage({ dir }) → StateStorage<string>

同仓库更多 Skills

同仓库

alpine-persist

stainless-code/persist

Gate Alpine.js UI on Persist hydration (Alpine.plugin + useHydrated / $hydrated). Use when wiring HydrationSignal into Alpine data components.

2026-07-234

angular-persist

stainless-code/persist

Gate Angular UI on Persist hydration with useHydrated (readonly Signal). Call inside an injection context; use when avoiding flash of default state on async backends.

2026-07-234

lit-persist

stainless-code/persist

Gate Lit element UI on Persist hydration with HydrationController. Use when wiring HydrationSignal into a ReactiveControllerHost; not a hook.

2026-07-234

persist-async-storage

stainless-code/persist

Persist with React Native AsyncStorage via @stainless-code/persist/backends/async-storage. Use for RN string-wire JSON state; always gate with useHydrated.

2026-07-234

persist-compressed

stainless-code/persist

Compress a string-wire StateStorage with @stainless-code/persist/backends/compressed (gzip/deflate). Backend wrapper — compose with createStorage; stack compress-then-encrypt.

2026-07-234

persist-crosstab

stainless-code/persist

Cross-tab sync for backends without storage events via @stainless-code/persist/transport/crosstab (createBroadcastCrossTab). Wrap storage + pass crossTabEventTarget; call close() on teardown.

2026-07-234

name	persist-node-fs
description	Persist to the filesystem with @stainless-code/persist/backends/node-fs (nodeFsStateStorage). StateStorage only — compose createStorage + codec; one file per key with hash suffix.
license	MIT
metadata	{"type":"composition","library":"@stainless-code/persist","library_version":"0.4.1"}
requires	["persist"]
sources	["stainless-code/persist:src/adapters/backends/node-fs.ts"]

Node filesystem backend

Minimal wiring

import { createStorage, jsonCodec } from "@stainless-code/persist";
import { nodeFsStateStorage } from "@stainless-code/persist/backends/node-fs";

const storage = createStorage<Prefs>(
  () => nodeFsStateStorage({ dir: "./.persist" }),
  jsonCodec(),
);

No optional peer for this backend — uses node:fs. Richer graphs → persist-seroval as the codec.

Common mistakes

Expecting a create*Storage PersistStorage factory.
Assuming sanitize alone makes unique paths — the hash suffix is required for collisions.
Path-traversal keys — refused after sanitize.

API surface

nodeFsStateStorage({ dir }) → StateStorage<string>