@freqhole/ api-客户端

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

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

安装

npm i @freqhole/api-client

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

快速开始

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。 。 。 .

在纽约市与..