可插件- io- 框架- api

API 用于 可插接- io- 框架

使用量

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

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

插件注册 IOProviderFactory (可选) PayloadConverters) 通过 动态插件框架 使用导出扩展点常数.

主要出口:

• 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 的多块写入器.

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- 框架 用于完整文档.

发展

安装依赖性 :

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 文档

许可证

麻省理工学院