@zerolith/client

中文文档
0.1.0-alpha.8发布于 2026/11/03Apache-2.0TypeScriptES Module零依赖构建来源已验证

A typed HTTP client for zerolith over a neutral contract: generate the route table and types from an OpenAPI document, call operations with checked inputs, and read failures as RFC 9457 problems

原始使用文档

@zerolith/client

A typed HTTP client over a neutral contract. zerolith-client reads an OpenAPI 3.x document and writes one TypeScript module: a type per component schema, an Api interface with one entry per operation, and the routes table the client runs on. createClient takes that table and checks every call against it: the operation name, its path and query parameters, its body, and what it resolves to.

npx zerolith-client openapi.json --out src/api.ts
import { createClient } from "@zerolith/client";
import { type Api, routes } from "./api.ts";

const api = createClient<Api>(routes, { baseUrl: "/api" });
const note = await api.call("getNote", { params: { id } });
const notes = api.query("listNotes", () => ({ query: { q: search.get() } }));

A response outside 2xx rejects with a ProblemError carrying the RFC 9457 problem the server sent, or one built from the status line. query wraps an operation in a resource that calls again when the signals it reads change. A custom transport answers requests in process, for tests or an Electron bridge, and the client never assumes which server produced the document.

The guide is on the docs site.

Status: alpha. Install with npm install @zerolith/client@alpha; the API may change before 1.0.

Documentation

  • The typed client guide explains it with examples that run as tests.
  • The reference lists every export, generated from the source.
  • New to zerolith? The tutorial builds an app step by step, and the playground runs code in the browser.

License

Apache-2.0. See LICENSE.

版本与发布记录

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

版本发布日期距今
0.1.0-alpha.8latest2026/11/03今天
0.0.0-canary.20261102.g8292c77canary2026/11/02今天
0.1.0-alpha.72026/11/011 天前
0.1.0-alpha.62026/11/011 天前
0.1.0-alpha.6.canary.20261101.g301d4192026/11/012 天前
0.1.0-alpha.5.canary.20261031.g3c0e1fb2026/10/313 天前

关于 @zerolith/client 的常见问题

@zerolith/client 是什么?

基于中立合约的zerolith类型HTTP客户端:从OpenAPI文档生成路由表和类型,调用带有检查输入的操作,以及读取RFC 9457问题的失败

如何安装 @zerolith/client?

在项目目录运行 npm install @zerolith/client,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zerolith(^0.1.0-alpha.8)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 zerolith-client,可以用 npx zerolith-client 直接运行。

@zerolith/client 支持 TypeScript 吗?

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

@zerolith/client 支持 ESM 还是 CommonJS?

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

@zerolith/client 需要什么版本的 Node.js?

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

@zerolith/client 可以商用吗?

@zerolith/client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@zerolith/client 还在维护吗?

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