@useairfoil/api

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

This package has the Effect clients for Wings catalogs and Arrow Flight ingestion.

原始使用文档

Airfoil API

This package has the Effect clients for Wings catalogs and Arrow Flight ingestion.

Install

pnpm add @useairfoil/api effect@^4

Usage

import { CatalogManager } from "@useairfoil/api";
import { Effect, Layer } from "effect";
import { FetchHttpClient } from "effect/http";

const catalog = CatalogManager.getCatalog("analytics").pipe(
  Effect.provide(
    CatalogManager.layer({ engineUrl: "http://localhost:7777" }).pipe(
      Layer.provide(FetchHttpClient.layer),
    ),
  ),
);

Use CatalogManager.ingestor(...) inside Effect.scoped. The first batch sets the Arrow schema. Later batches on that stream must use the same schema.

getIcebergCatalog(id) connects directly to the registered catalog URI. The caller needs network access to that URI. Requests use the registered token and header.* properties for authentication and headers.

版本与发布记录

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

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

关于 @useairfoil/api 的常见问题

@useairfoil/api 是什么?

这个包有影响客户为翅膀目录和箭飞行摄取。

如何安装 @useairfoil/api?

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

@useairfoil/api 支持 TypeScript 吗?

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

@useairfoil/api 支持 ESM 还是 CommonJS?

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

@useairfoil/api 可以商用吗?

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

@useairfoil/api 还在维护吗?

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