# @freqhole/api-client 中文文档

规范地址：https://npmcn.com/package/%40freqhole/api-client/

版本：0\.3\.27
npm 元数据更新时间：2026-11-10T03:19:44.963Z
中文译文更新时间：2026-11-15T14:30:43.972Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40freqhole/api-client
原文对照：https://npmcn.com/package/%40freqhole/api-client/?lang=original
项目主页：https://github.com/freqhole/tomb#readme
源码仓库：https://github.com/freqhole/tomb

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：750 kB，46 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2026-06-18T01:32:19.791Z
- 最新版本发布：2026-11-10T03:19:44.611Z
- 近 30 天下载量：2663（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

用于 freqhole API 的 类型安全 TypeScript 客户端.

## 安装

```sh
npm install @freqhole/api-client
```

也可以使用：`pnpm add @freqhole/api-client`、`yarn add @freqhole/api-client`、`bun add @freqhole/api-client`

## README

# @freqhole/ api-客户端

用于 freqhole API 的 类型安全 TypeScript 客户端.

此软件包将生成的路由 + schema 元数据用一个小运行时的客户端来包装, 因此请求在输入和输出上都被验证和输入 .

## 安装

```bash
npm i @freqhole/api-client
```

对于本地单列波使用,此回放通常通过文件路径将其链接.

## 快速开始

```ts
import { createHttpClient } from "@freqhole/api-client";

const api = createHttpClient({
  baseUrl: "http://localhost:4315",
});

const songs = await api.music.listSongs({
  query: { limit: 25, offset: 0 },
});

if (songs.success) {
  console.log(songs.data.songs.length);
}
```

## 软件包结构

-   `src/codegen/schema.ts`: 生成 zod 计划
-   `src/codegen/routes.ts`: 生成的路由元数据
-   `src/*.ts`: 手写助手和客户端适配器

避免编辑文件 `src/codegen/` 直接说.

## 发展说明

如果您正在使用此重播程序, 并且需要重生类型/ 路由, 请运行代码源 `client-codegen/`。 。 。 .

完整的生成器工作流程和架构文件 `client-codegen/README.md`。 。 。 .

* * *

在纽约市与..

## 常见问题

### @freqhole/api-client 是什么？

用于 freqhole API 的 类型安全 TypeScript 客户端\.

### 如何安装 @freqhole/api-client？

在项目目录运行 npm install @freqhole/api-client，或使用 pnpm add / yarn add / bun add。

### @freqhole/api-client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/freqhole\_\_api-client 是否存在。

### @freqhole/api-client 支持 ESM 还是 CommonJS？

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

### @freqhole/api-client 可以商用吗？

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

### @freqhole/api-client 的下载量有多少？

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

### @freqhole/api-client 还在维护吗？

最新版本 0\.3\.27 发布于 2026/11/10（5 天前）；至今共发布 45 个版本，其中过去 12 个月发布了 45 个；首次发布于 2026/06/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。