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

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

版本：3\.1\.10
npm 元数据更新时间：2026-11-12T04:48:59.061Z
中文译文更新时间：2026-11-15T00:51:50.570Z
软件包许可：MIT

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

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

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

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

## 中文简介

API 用于 [https://github.com/flowscripter/pluggable-io-framework 互联网档案馆的存檔,存档日期2014-12-21](https://github.com/flowscripter/pluggable-io-framework)

## 安装

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

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

## README

# 可插件- io- 框架- api

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

> API 用于 [可插接- io- 框架](https://github.com/flowscripter/pluggable-io-framework)

## 使用量

提供者插件作者应该依赖于此软件包( 不是完整) `@flowscripter/pluggable-io-framework`作为 `peerDependency`数字 :

```jsonc
{
  "peerDependencies": {
    "@flowscripter/pluggable-io-framework-api": "*",
  },
}
```

插件注册 `IOProviderFactory` (可选) `PayloadConverter`s) 通过 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework) 使用导出扩展点常数.

主要出口:

-   `IOProviderFactory` - 宣布供货商 `protocol`, (中文(简体) ), `PayloadKind`,位置/配置/财产 Zod schemas, 将一个位置转换为提供者配置外加 a `LocationTarget`。 。 。 .
-   `IOProvider` - 配置的源/汇:流、属性、列表和可选多部分, 直接转移和恢复支持.
-   `Item`, (中文(简体) ), `JsPayload`, (中文(简体) ), `NativePayload`, (中文(简体) ), `PayloadKind` - 溪流装置及其有效载荷种类.
-   `StreamHandle` 加上能力接口和警卫`RangeReadable`, (中文(简体) ), `Seekable`, (中文(简体) ), `BufferProvider`, (中文(简体) ), `FillReadable`, (中文(简体) ), `ResumableWritable`(中文(简体) ).
-   `ProviderContext`编号 :`ProviderResolver`, (中文(简体) ), `PayloadConverter`, (中文(简体) ), `TelemetryHooks`, (中文(简体) ), `TransientIOError`编号 :`PermanentIOError`。 。 。 .

## 条目、项目和部件

-   一个 **条目** 是一个单个存储的东西 提供者地址按键: 文件, 一个对象, HTTP 资源。 它的元数据是 `EntryProperties`条目 住在这里 **集装箱** (目录、前缀)和a `LocationTarget` 指定条目、容器或条目模式.
-   一个 **项目** 是流带的单位:可选属性外加a 有效载荷(`JsPayload` 或者说 `NativePayload`) (中文(简体) ). 通过 a 读取条目 `StreamHandle` 生成项目序列;将项目写入可写入的 `StreamHandle` 生成条目。 一个条目通常是许多项.
-   A 类 **编** 是多段传输中条目的一个字节范围: a `index`,一个 `offset` 和它自己的物品流。 一个条目被拆分为 使部件能够同时被转移,并由 switch 的多块写入器.

```mermaid
classDiagram
    direction LR
    class Entry {
      key
      EntryProperties
    }
    class Part {
      index
      offset
      stream
    }
    class Item {
      attributes?
      payload
    }
    Entry "1" --> "*" Part : split into (multipart)
    Entry "1" --> "*" Item : streamed as
    Part "1" --> "*" Item : streamed as
```

见 [可插接- io- 框架](https://github.com/flowscripter/pluggable-io-framework) 用于完整文档.

## 发展

安装依赖性 :

`bun install`

构建(生产) `dist/` 对于Node.js和TypeScript消费者; Bun 直接使用原始来源:

`bun run build`

测试 :

`bun test`

格式 :

`bunx oxfmt`

林特:

`bunx oxlint index.ts src/ tests/`

生成 HTML API 文档 :

`bunx typedoc index.ts`

### API 密码

自动生成的 API 文件 :

[API 文档](https://flowscripter.github.io/pluggable-io-framework-api/index.html)

## 许可证

麻省理工学院

## 常见问题

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

API 用于 https://github\.com/flowscripter/pluggable-io-framework 互联网档案馆的存檔,存档日期2014-12-21

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

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

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

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

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

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

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

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

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

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

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

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