# @flowscripter/pluggable-io-framework 中文文档

规范地址：https://npmcn.com/package/%40flowscripter/pluggable-io-framework/

版本：2\.1\.13
npm 元数据更新时间：2026-11-12T05:43:26.197Z
中文译文更新时间：2026-11-15T00:55:52.290Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flowscripter/pluggable-io-framework
原文对照：https://npmcn.com/package/%40flowscripter/pluggable-io-framework/?lang=original
项目主页：https://github.com/flowscripter/pluggable-io-framework#readme
源码仓库：https://github.com/flowscripter/pluggable-io-framework

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

- 包体积（解压后）：188 kB，135 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：typescript ^7\.0\.2
- 首次发布：2026-08-02T10:11:19.293Z
- 最新版本发布：2026-11-12T05:43:25.855Z
- 近 30 天下载量：2475（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

使用可插接源/ 连接 IO 框架 [https://github.com/flowscripter/动态-插图-框架](https://github.com/flowscripter/dynamic-plugin-framework)

## 安装

```sh
npm install @flowscripter/pluggable-io-framework
```

也可以使用：`pnpm add @flowscripter/pluggable-io-framework`、`yarn add @flowscripter/pluggable-io-framework`、`bun add @flowscripter/pluggable-io-framework`

## README

# 可插接- io- 框架

[![version](https://img.shields.io/github/v/release/flowscripter/pluggable-io-framework?sort=semver)](https://github.com/flowscripter/pluggable-io-framework/releases) [![build](https://img.shields.io/github/actions/workflow/status/flowscripter/pluggable-io-framework/release-bun-library.yml)](https://github.com/flowscripter/pluggable-io-framework/actions/workflows/release-bun-library.yml) [![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/pluggable-io-framework/index.html) [![license: MIT](https://img.shields.io/github/license/flowscripter/pluggable-io-framework)](https://github.com/flowscripter/pluggable-io-framework/blob/main/LICENSE)

> 使用可插接源/ 连接 IO 框架 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework)

## 关键特性

-   协议意识位置,作为字符串(`file:///data/a.txt`, (中文(简体) ), `s3://bucket/key`, (中文(简体) ), `https://host/a`综合计划,例如: `tams+https:`; 空路径默认为 `file`)或结构化 `{ protocol, location }` 对象。 选择已安装的提供者 该协议的插件 。 见 [字符串和结构化位置](https://npmcn.com/package/%40flowscripter/pluggable-io-framework/README/key-concepts.md#string-and-structured-locations)。 。 。 .
-   A 类 `ProviderRegistry` 按协议和有效载荷类型按键,有多个 执行并存的议定书(例如,联合来文和土著文书) `file` 提供方).
-   有效载荷种类、内存域和有效载荷类型的谈判 源和汇,倒入最便宜的注册有效载荷转换器 插件 .
-   `copy`编号 :`move` 明确进入、集装箱和光滑模式目标, 与 `cp -r` 容器的语义学.
-   直接提供者对提供者的转让,经谈判的多部分转让 部件大小,零副本租赁转至汇提供的缓冲器或平面 流出 - 自动选择 .
-   优雅地停站和取消,按部分重试,可续写和 实时源的自动重联与差距报告.
-   货币限制的递归和模式转移,有进展 遥测.
-   提供商构成:提供商可以解决其他已安装的提供商.
-   串流装饰 : `seekable` 财务报告和审定财务报表 `locallyCached`。 。 。 .
-   Bun基于TypeScript,以原生的JavaScript模块来编写.

## 用法实例

-   [流程描述器- io- cli](https://github.com/flowscripter/flowscripter-io-cli) 是一个基于此框架的 CLI 应用程序.
-   [io- plugin 文件系统](https://github.com/flowscripter/io-plugin-filesystem) 是参考文献 `file` 提供者插件.

```typescript
import {
  DefaultPluginManager,
  LocalFolderPluginRepository,
} from "@flowscripter/dynamic-plugin-framework";
import { copy, ProviderRegistry } from "@flowscripter/pluggable-io-framework";

const registry = new ProviderRegistry(
  new DefaultPluginManager([new LocalFolderPluginRepository("./plugins")]),
);
await registry.discover();

const { source, dest, options } = await registry.createProvidersForTransfer(
  "file:///data/in",
  "s3://bucket/out",
);

const result = await copy(source.provider, source.target, dest.provider, dest.target, {
  ...options,
  telemetry: { onProgress: (event) => console.log(event) },
});
console.log(result.path);
```

## 进一步详情

-   [关键概念](https://npmcn.com/package/%40flowscripter/pluggable-io-framework/README/key-concepts.md)
-   [执行细节](https://npmcn.com/package/%40flowscripter/pluggable-io-framework/README/implementation-details.md)
-   [插件](https://npmcn.com/package/%40flowscripter/pluggable-io-framework/README/plugins.md)
-   [发展](https://npmcn.com/package/%40flowscripter/pluggable-io-framework/README/development.md)
-   [API 文档](https://flowscripter.github.io/pluggable-io-framework/index.html)

## 许可证

麻省理工学院

## 常见问题

### @flowscripter/pluggable-io-framework 是什么？

使用可插接源/ 连接 IO 框架 https://github\.com/flowscripter/动态-插图-框架

### 如何安装 @flowscripter/pluggable-io-framework？

在项目目录运行 npm install @flowscripter/pluggable-io-framework，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^7\.0\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flowscripter/pluggable-io-framework 支持 TypeScript 吗？

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

### @flowscripter/pluggable-io-framework 支持 ESM 还是 CommonJS？

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

### @flowscripter/pluggable-io-framework 可以商用吗？

@flowscripter/pluggable-io-framework 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flowscripter/pluggable-io-framework 的下载量有多少？

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

### @flowscripter/pluggable-io-framework 还在维护吗？

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