@useairfoil/testing

中文文档
0.2.0发布于 2026/11/03TypeScriptES Module构建来源已验证

This package provides an Effect layer to spin up the Airfoir storage engine and its dependencies in a container.

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. API

Airfoil testing

This package provides an Effect layer to spin up the Airfoir storage engine and its dependencies in a container.

Docker is required.

Install

pnpm add -D @useairfoil/testing effect@^4

Usage

import { TestEngine } from "@useairfoil/testing";
import { Effect } from "effect";

Effect.gen(function* () {
  const engine = yield* TestEngine.Instance;
  const uri = yield* engine.uri;
  const icebergRestUri = yield* engine.icebergRestUri;
});

API

TestEngine.Instance

  • uri: Effect<string>: the engine's uri.
  • icebergRestUri: Effect<string>: the iceberg rest catalog uri.
  • engineIcebergRestUri: Effect<string>: the iceberg rest catalog, reachable from inside the container.
  • accessKeyId and secretAccessKey: the S3 credentials.
  • materializeAndCommit(catalogId, table): publish the ingested rows and wait for a new iceberg snapshot.

Use the engine address when registering a catalog for ingestion, and the host address for direct Iceberg client calls. Separate registrations can point to the same catalog and tables. No host LAN address is needed.

版本与发布记录

@useairfoil/testing 共发布 3 个版本,首次发布于 2026/10/31;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.0latest2026/11/03今天
0.0.12026/10/313 天前
0.0.0-stage2026/10/313 天前

关于 @useairfoil/testing 的常见问题

@useairfoil/testing 是什么?

这个包提供了一个Effect层来启动Airfoir存储引擎及其在容器中的依赖关系。

如何安装 @useairfoil/testing?

在项目目录运行 npm install @useairfoil/testing,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:effect(^4.1.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@useairfoil/testing 支持 TypeScript 吗?

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

@useairfoil/testing 支持 ESM 还是 CommonJS?

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

@useairfoil/testing 可以商用吗?

@useairfoil/testing 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@useairfoil/testing 还在维护吗?

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