@chunkd/source

中文文档
11.4.2发布于 2026/10/23MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 2.2万

用于所有源的基础接口 @chunkd

中文使用文档

@ chunkd/ 来源

用于所有源的基础接口 @chunkd

export interface Source {
  /**
   * human friendly name of the source type
   * @example "aws:s3", "file", "memory"
   */
  type: string;

  /**
   * URL to the source
   *
   * @example "s3://linz-imagery/catalog.json" or "file:///home/blacha/18_126359_137603.webp"
   */
  url: URL;

  /** Metadata about the object the source represents */
  metadata?: SourceMetadata;

  /** Read the metadata before a fetch request */
  head(): Promise<SourceMetadata>;

  /** close the source, sources like files sometimes have open file handles that need to be closed */
  close?(): Promise<void>;

  /**
   * Directly read bytes from the source
   *
   * @example
   * ```typescript
   *  source.fetch(0, 1024) // load the first 1024 bytes
   *  source.fetch(1024, 20) // read 20 bytes at offset 1024
   *  source.fetch(-1024) // load the last 1024 bytes
   *```
   * @param offset Byte to start reading form
   * @param length optional number of bytes to read
   */
  fetch(offset: number, length?: number): Promise<ArrayBuffer>;
}

实例

示例来源

版本与发布记录

@chunkd/source 共发布 7 个版本,首次发布于 2023/07/20;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
11.4.2latest2026/10/2317 天前
11.4.12026/05/235 个月前
11.4.02026/03/277 个月前
11.3.02026/03/247 个月前
11.2.02026/03/048 个月前
11.1.02023/08/243 年前

关于 @chunkd/source 的常见问题

@chunkd/source 是什么?

用于所有源的基础接口 @chunkd

如何安装 @chunkd/source?

在项目目录运行 npm install @chunkd/source,或使用 pnpm add / yarn add / bun add。

@chunkd/source 支持 TypeScript 吗?

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

@chunkd/source 支持 ESM 还是 CommonJS?

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

@chunkd/source 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@chunkd/source 可以商用吗?

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

@chunkd/source 的下载量有多少?

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

@chunkd/source 还在维护吗?

最新版本 11.4.2 发布于 2026/10/23(17 天前);至今共发布 7 个版本,其中过去 12 个月发布了 5 个;首次发布于 2023/07/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。