# @dbx-tools/shared-fs 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/shared-fs/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:12.791Z
中文译文更新时间：2026-11-11T17:20:18.422Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/shared-fs
原文对照：https://npmcn.com/package/%40dbx-tools/shared-fs/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：277 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-07-31T05:45:51.299Z
- 最新版本发布：2026-11-10T19:18:12.433Z
- 近 30 天下载量：12581（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：285（近 12 个月 285 个）

## 中文简介

浏览器- 安全文件系统合同和定义存储后端的抽象基础

## 安装

```sh
npm install @dbx-tools/shared-fs
```

也可以使用：`pnpm add @dbx-tools/shared-fs`、`yarn add @dbx-tools/shared-fs`、`bun add @dbx-tools/shared-fs`

## README

# @dbx-工具/共享-fs

使用一个文件系统合同,跨越内存,本地磁盘,团结目录卷, 和其他有根的存储后端。 这个浏览器安全包提供了 便携式 `FileSystem` 接口, `BaseFileSystem`路径 帮手, 缓冲, 一个内膜适配器.

## 快开始

```ts
import { MemoryFileSystem } from "@dbx-tools/shared-fs";

const files = new MemoryFileSystem();
await files.writeFile("note.txt", "ready");
```

文件系统合同包括:

-   可移植 `FileSystem` 用于读取、写取、附加、复制、移动、目录、, 和存在操作.
-   `BaseFileSystem` 根接受一个或多个段。 物体为FNV-hashed, 财务报告和审定财务报表 `true` 财务报告和审定财务报表 `1` 被字符串化。 字符串被分割 `/`,而且只有一个 组成部分 _无法_ 成为路径组件( 分隔符, NUL / 控制) 字符,或 `..`)是FNV-hashed,所以真实的名字像 `/Workspace/Users/me@corp.com/My Notes` 幸存下来.
-   `BaseFileSystem` 让新的后端主要执行 `*At` 原始的 原始的 原始的 这个 提供回忆 `_init`选项 `createRoot`, (中文(简体) ), `toBackendPath`父关 变异前创建, POSIX 仅限路径, 编码, 递归目录 操作,以及附加,复制,并移动后退.
-   每一个原始人都会通过一个守卫 被引向失败 `mapError` 钩子,所以适配器没有自己的尝试/捕获,不能 返回一个非正态错误.
-   `MemoryFileSystem` 用于测试和参考执行的流程中适配器.
-   `baseFS.mapFileSystemError` 编号 : `baseFS.inferFileSystemErrorCode` 打开 `@dbx-tools/shared-core` 错误帮助者 .
-   `posixPath` 将根/子转换为 `/`\- 分开的表格 (单位:千美元)`posixPath.toPosix` 财务报告和审定财务报表 `posixPath.join`) (中文(简体) ).
-   类型 `FileSystemError` 便携式故障处理的代码.
-   每次公共文件系统操作的懒惰调试日志. 设定 `LOG_LEVEL=debug`。操作元数据不是按正常日志水平构建的.
-   `cache()` 自动变异无效的读取器. `exists`, (中文(简体) ), `readdir`,以及 `stat` 默认为缓存。 其他方法 除非明确选中。 缓存所有者曝光 `keys()` 这样 目录移动/删除操作可以使相关的祖先无效 后人条目. `read`, (中文(简体) ), `invalidate`,以及 `keys` 可能是同步的或 一个同步。 密钥使用 `<stable-hash>_<canonical-rooted-backend-path>`。 。 。 .

## 选择运行时间

当多个后端必须执行相同的API时使用此软件包. 浏览器 代码可以使用合同,路径辅助器,缓存装饰器,以及 `MemoryFileSystem`。节点主机提供诸如 [@dbx-tools/fs (英语)](https://npmcn.com/package/node/fs),包括: `LocalFileSystem`。 。 。 .

## 使用缓存和后端帮助

```ts
import type { FileSystem, FileSystemCache } from "@dbx-tools/shared-fs";
import {
  BaseFileSystem,
  FileSystemError,
  fs,
  MemoryFileSystem,
  posixPath,
} from "@dbx-tools/shared-fs";

const mem = new MemoryFileSystem();
await mem.writeFile("note.txt", "hi");
const cached = fs.cache(mem, myCache satisfies FileSystemCache);
await cached.stat("note.txt");

const selected = fs.cache(mem, myCache, {
  operations: ["readFile", "readdir"],
  filter: (operation, path) => operation === "readdir" || path.startsWith("/skills/"),
});
```

默认缓存 `exists`, (中文(简体) ), `readdir`,以及 `stat`。 。 。 . `filter` 接收 操作和规范化的绝对路径,所以自有软件包可以编译其 拥有 glob 或授权政策,但不在此添加路径匹配依赖 .

## 软件包出口

| 导出 | 作用 |
| --- | --- |
| `FileSystem` | 可移植文件系统合同 |
| `BaseFileSystem` | 摘要基础 `*At` 有记忆的原始人 `_init` |
| `baseFS.normalizeFileSystemRoot` | 加入根段( 字符串 / FNV- hash) |
| `FileSystemRootInput` | `root` 选项:一个或多个非null段 |
| `MemoryFileSystem` | 模拟适配器(测试/参考) |
| `memoryFS` | 它背后的模块,如果一个子类需要它的内部 |
| `baseFS.mapFileSystemError` | 将后端失败折叠到 `FileSystemError` |
| `baseFS.inferFileSystemErrorCode` | 从 HTTP 状态/ 消息符号推断代码 |
| `posixPath` | POSIX root/join/ 规范命名空间路径的助手 |
| `posixPath.isHomeRelativePath` | `~` 编号 : `~/...` 检测, 每个适配器共享 |
| `posixPath.expandHome` | 扩展 `~` 对一个家庭,一个可插接的结合 |
| `posixPath.toRelativeSegment` | 脱去领先 `~` / 分隔符这样输入会在一个基数下加入 |
| `FileSystemError` | 输入的文件系统失败 |
| `FileEntry` 编号 : `FileStat` / 选项类型 | 共享数据类型 |

## 常见问题

### @dbx-tools/shared-fs 是什么？

浏览器- 安全文件系统合同和定义存储后端的抽象基础

### 如何安装 @dbx-tools/shared-fs？

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

### @dbx-tools/shared-fs 支持 TypeScript 吗？

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

### @dbx-tools/shared-fs 支持 ESM 还是 CommonJS？

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

### @dbx-tools/shared-fs 可以商用吗？

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

### @dbx-tools/shared-fs 的下载量有多少？

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

### @dbx-tools/shared-fs 还在维护吗？

最新版本 0\.9\.206 发布于 2026/11/11（今天）；至今共发布 285 个版本，其中过去 12 个月发布了 285 个；首次发布于 2026/07/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。