@dbx-tools/fs

中文文档
0.9.206发布于 2026/11/11Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 8934

节点本地磁盘执行 dbx-tools 浏览器安全文件系统合同

中文使用文档
文档目录4 节
  1. 快开始
  2. 选择应用程序或代理文件系统
  3. 文件系统助手
  4. 模块

@dbx-tools/fs (英语)

使用 @dbx-tools/shared-fs 与来自Node.js的本地磁盘签订合同。 这个 执行中增加了主机分隔器转换,节点一/O,并联封存, 错误映射到 BaseFileSystem。 。 。 .

快开始

import { LocalFileSystem } from "@dbx-tools/fs";

const files = new LocalFileSystem({ root: "./data" });
await files.init();
await files.writeFile("hello.txt", "hi");

执行工作规定:

  • 在已配置的根下包含默认路径解析
  • ~ 编号 : ~/... 使用 os.homedir() (在 HOME,则 数据砖App /home/app,然后创建一个 ./.home (创建失败跳过)
  • 使用时间 os.tmpdir() 接下来 TMPDIR 编号 : TMP 编号 : TEMP,则 <home>/.tmp (每个候选人都必须通过书面/删除探测)
  • 阅读/写作/附录/复制/移动外加mkdir/rmdir/readdir/stat/性别歧视
  • 可选只读模式
  • 在可用时使用节点创建附件、复制并重命名
  • 同一稳定临时树同时重建的跨进程序列化

选择应用程序或代理文件系统

打电话者要讲便携时用这个 FileSystem 接口(相同) 表面 FTP、 对象存储或 Databricks 挂载可以执行) 而不是 节点API直接. 到达 node:fs 当你只需要一次性的本地 I/O.

当应用程序路径或UI 组件需要管理时使用 AppKit 文件插件 统一目录体积操作. 使用 @dbx-tools/ 数据砖 用于服务器侧工作空间,音量,或 DBFS访问. 挂载任何便携式 FileSystem 输入 @dbx-tools/appkit-mastra (英语) 当代理需要文件工具时. 在主机本地数据和临时工作树上使用此软件包 .

文件系统助手

import { LocalFileSystem, localFS } from "@dbx-tools/fs";

const local = new LocalFileSystem({ root: "./data" });
await local.init();
await local.writeFile("hello.txt", "hi");

const home = localFS.homeFS("projects/data");
const scratch = localFS.tmpFS("job-42");

// A throwaway working directory no other run can collide with.
const work = localFS.scratchFS("import-job");
await work.init(); // only needed when handing the root to `node:fs` or a subprocess

// Regenerate on every boot, but into one stable directory: the callback writes
// into a scratch root that replaces the stable one only on success, so restarts
// don't pile up directories, a failed rebuild keeps the last good tree, and
// concurrent rebuilds of the same key are serialized across processes.
const skills = await localFS.rebuildFS("agent-skills", async (scratch) => {
  await scratch.writeFile("SKILL.md", "# Generated skill\n");
});

模块

导出作用
LocalFileSystem本地盘片 FileSystem<"local">
LocalFileSystemOptions构造选项
localFS.homeFS 编号 : localFS.tmpFSLocalFileSystem 未解决的家庭/临时
localFS.scratchFStmpFS 编号 <prefix>-<id> 每个呼叫的根独有
localFS.rebuildFS使用原子抓痕交换进行串接式稳定临时重建
osPath.resolveLocalHomeƯμ㼯A homedir → HOME → /home/app → ./.home
osPath.resolveLocalTemp时间 : tmpdir → TMPDIR编号 :TMP编号 :TEMP → <home>/.tmp
localPath.expandLocalHomePath扩展 ~ 对抗家庭目录

相邻 : @dbx-tools/shared-fs (单位:千美元)FileSystem 合同+ BaseFileSystem) (中文(简体) ).

版本与发布记录

@dbx-tools/fs 共发布 283 个版本,首次发布于 2026/07/31;过去 12 个月发布了 283 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.9.206latest2026/11/11今天
0.9.2052026/11/111 天前
0.9.2042026/11/101 天前
0.9.2032026/11/074 天前
0.9.2022026/11/065 天前
0.9.2012026/11/056 天前

关于 @dbx-tools/fs 的常见问题

@dbx-tools/fs 是什么?

节点本地磁盘执行 dbx-tools 浏览器安全文件系统合同

如何安装 @dbx-tools/fs?

在项目目录运行 npm install @dbx-tools/fs,或使用 pnpm add / yarn add / bun add。

@dbx-tools/fs 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dbx-tools/fs 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@dbx-tools/fs 可以商用吗?

@dbx-tools/fs 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dbx-tools/fs 的下载量有多少?

根据 npm 官方下载统计,@dbx-tools/fs 在 2026/10/12 – 2026/11/10 这 30 天内被下载 8,934 次,日均约 298 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dbx-tools/fs 还在维护吗?

最新版本 0.9.206 发布于 2026/11/11(今天);至今共发布 283 个版本,其中过去 12 个月发布了 283 个;首次发布于 2026/07/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。