# @flowscripter/io-plugin-filesystem 中文文档 规范地址：https://npmcn.com/package/%40flowscripter/io-plugin-filesystem/ 版本：2\.0\.11 npm 元数据更新时间：2026-11-12T06:52:52.695Z 中文译文更新时间：2026-11-15T04:52:01.396Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40flowscripter/io-plugin-filesystem 原文对照：https://npmcn.com/package/%40flowscripter/io-plugin-filesystem/?lang=original 项目主页：https://github.com/flowscripter/io-plugin-filesystem#readme 源码仓库：https://github.com/flowscripter/io-plugin-filesystem ## 关键信息（来自 npm 元数据） - 包体积（解压后）：101 kB，4 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - 运行依赖：2 个 - peer 依赖：typescript ^7\.0\.2，@flowscripter/dynamic-plugin-framework \* - 首次发布：2026-08-16T04:51:38.136Z - 最新版本发布：2026-11-12T06:52:51.838Z - 近 30 天下载量：2120（2026-10-15 至 2026-11-13，npm 官方下载统计） - 已发布版本数：29（近 12 个月 29 个） ## 中文简介 本地文件系统源/ sink 插件 [https://github.com/flowscripter/pluggable-io-framework 互联网档案馆的存檔,存档日期2014-12-21](https://github.com/flowscripter/pluggable-io-framework) ## 安装 ```sh npm install @flowscripter/io-plugin-filesystem ``` 也可以使用：`pnpm add @flowscripter/io-plugin-filesystem`、`yarn add @flowscripter/io-plugin-filesystem`、`bun add @flowscripter/io-plugin-filesystem` ## README # io- plugin 文件系统 [![version](https://img.shields.io/github/v/release/flowscripter/io-plugin-filesystem?sort=semver)](https://github.com/flowscripter/io-plugin-filesystem/releases) [![build](https://img.shields.io/github/actions/workflow/status/flowscripter/io-plugin-filesystem/release-bun-library.yml)](https://github.com/flowscripter/io-plugin-filesystem/actions/workflows/release-bun-library.yml) [![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/io-plugin-filesystem/index.html) [![license: MIT](https://img.shields.io/github/license/flowscripter/io-plugin-filesystem)](https://github.com/flowscripter/io-plugin-filesystem/blob/main/LICENSE) > 本地文件系统源/ sink 插件 [可插接- io- 框架](https://github.com/flowscripter/pluggable-io-framework), (中文(简体) ), 通过 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework) ## 关键特性 - 执行 `IOProviderFactory`编号 :`IOProvider` 合同来源 [可插件- io- 框架- api](https://github.com/flowscripter/pluggable-io-framework-api) 用于本地文件系统 - 源和汇. - 工厂 `file` 与 `js` 载荷种类。 地点是 `file:` URL数(`file:///foo` 或者说 `file:/foo`)或由 `filesystemLocationSchema` (单位:千美元)`path`外加可选选项 `filename` (单位:千美元) 单项或一格 `pattern` 为匹配条目. `toProviderInputs` 加入 `path` 财务报告和审定财务报表 `filename` 将 OS 路径分隔为 `LocationTarget`。 。 。 . - 配置 : `{ rootPath?: string }` (与佐德验证) - `rootPath` 实值 选项,默认为 `""`。传递给提供者方法的所有路径是 解开并装入沙盒 `rootPath` - 一条能够逃脱的路 拒绝. `rootPath: ""` (或省略)是明确发送的“否” 自POSIX以来, 限制( 完整文件系统访问) `"/"` 这不是一个 在 Windows 有实际意义的“ 每件事” 根( 多驱动器字母, 无) 单文件系统根). 从字符串解析的位置总是使用 无限制配置 . - `list` (可重复、可监管过滤), `getProperties` (大小/最后修改/集装箱加a) `mode` 扩展属性, `setProperties` (单位:千美元)`lastModified` 加一个 `mode` 经验证的财产 `filesystemSettablePropertySchema`, (中文(简体) ), `delete`, (中文(简体) ), `createContainer` 财务报告和审定财务报表 `joinKey`。 。 。 . - 可读手柄已执行 `RangeReadable` (单位:千美元)`readRange(start, end)` 与 独家 `end`) (中文(简体) ). 可写字的手柄已执行 `ResumableWritable`数字 : 恢复文件当前大小的附件,报告为 `startOffset`。 。 。 . - 多段写入( 直接写入文件的当前字节行距部分) 通过一个共享文件控件抵消),以呼叫器提供的部件大小 - `getPartSizeConstraints` 报告有 8MB 默认值的未约束的边界, 由于本地文件系统没有规定真正的部分大小限制. - `canDirectTransfer`编号 :`directCopy`编号 :`directMove`: 两个 `FilesystemIOProvider` 相同实例 `rootPath` 复制/直接移动(`cp`编号 :`rename`,与 a 一个 `EXDEV` 交叉设备倒置为递归式副本+去除)而不是 流畅. `supportsRecursiveDirectTransfer` 实值 `true` - 一个目录 `sourcePath` 复制/递归 `directCopy`编号 :`directMove` 调用,保留空子目录. - 捆绑( B)`bun build --target bun`)作为单文件插件,由 `dynamic-plugin-framework` 通过 `import()` - 被证明是终结的 真正的repo测试 `LocalFolderPluginRepository`不仅仅是 类型检查. - 可通过 `NpmPluginRepository` (背后的机制) `dynamic-cli-framework`是因为 `plugin add`编号 :`plugin list` 命令( c) : 软件包.json `pluggable-io-framework` 字段声明此软件包 扩展点,所以一旦安装到 CLI 本地插件存储器中,它就是 不需要消耗性CLI 直接依赖它 也证明结束 在这个repo的测试, 不只是打字. ## 字符串和结构化位置 A 类 `file` 位置可分为两种形式: - 字符串: a `file:` URL (中文(简体) )`file:///foo` 或者说 `file:/foo`或赤裸裸的 路径. `parseLocationString` 仅返回 `{ path }`,所以弦总是 处理整个问题 `path` 作为 `container` 目标。 字符串是 用于持有路径或 URL 的代码的方便格式,以及其它格式 提供者在解析时使用 `file` 地点. - 结构化位置对象, `{ path, filename?, pattern? }`,验证 以 `filesystemLocationSchema` 直接说 需要解决单一问题 文件( 编号`filename`,一个 `entry` 目标)或匹配 glob 的文件 (单位:千美元)`pattern`页:1 `pattern` ),字符串不能表达. ## Bundled Bun 模块使用量 装入为 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework) 插件 - 关于主机应用程序如何发现和查看项目的文件 即时插件 。 直接使用捆绑,在其中 `registry` 是一个 可插接- io- 框架 `ProviderRegistry` (或任何 `ProviderResolver`: ```typescript import filesystemPlugin, { filesystemIOProviderFactory, } from "https://unpkg.com/@flowscripter/io-plugin-filesystem/dist/bundle.js"; const provider = await filesystemIOProviderFactory.createProvider( { rootPath: "/data" }, { resolver: registry }, ); ``` ## 发展 安装依赖性 : `bun install` 测试 : `bun test` 用作工具箱 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework) 插件 : `bun run build` 格式 : `bunx oxfmt` 林特: `bunx oxlint index.ts src/ tests/` 生成 HTML API 文档 : `bunx typedoc index.ts` ## 文档 ### 概览 参见 [可插件- io- 框架- api](https://github.com/flowscripter/pluggable-io-framework-api) 财务报告和审定财务报表 [可插接- io- 框架](https://github.com/flowscripter/pluggable-io-framework) 用于合同和该插件的管弦. ### API 密码 链接自动生成的 API 文件 : [API 文档](https://flowscripter.github.io/io-plugin-filesystem/index.html) ## 许可证 麻省理工学院 ## 常见问题 ### @flowscripter/io-plugin-filesystem 是什么？ 本地文件系统源/ sink 插件 https://github\.com/flowscripter/pluggable-io-framework 互联网档案馆的存檔,存档日期2014-12-21 ### 如何安装 @flowscripter/io-plugin-filesystem？ 在项目目录运行 npm install @flowscripter/io-plugin-filesystem，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^7\.0\.2）、@flowscripter/dynamic-plugin-framework（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @flowscripter/io-plugin-filesystem 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/flowscripter\_\_io-plugin-filesystem 是否存在。 ### @flowscripter/io-plugin-filesystem 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @flowscripter/io-plugin-filesystem 可以商用吗？ @flowscripter/io-plugin-filesystem 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @flowscripter/io-plugin-filesystem 的下载量有多少？ 根据 npm 官方下载统计，@flowscripter/io-plugin-filesystem 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,120 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @flowscripter/io-plugin-filesystem 还在维护吗？ 最新版本 2\.0\.11 发布于 2026/11/12（3 天前）；至今共发布 29 个版本，其中过去 12 个月发布了 29 个；首次发布于 2026/08/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。