# @cavuno/board 中文文档

规范地址：https://npmcn.com/package/%40cavuno/board/

版本：4\.64\.0
npm 元数据更新时间：2026-11-05T22:56:49.185Z
中文译文更新时间：2026-11-09T05:35:07.549Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cavuno/board
原文对照：https://npmcn.com/package/%40cavuno/board/?lang=original
项目主页：https://cavuno.com/docs/sdk
源码仓库：https://github.com/wollemiahq/cavuno-sdk

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

- 包体积（解压后）：3.3 MB，125 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-12T04:06:21.429Z
- 最新版本发布：2026-11-05T22:56:48.780Z
- 近 30 天下载量：6488（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：130（近 12 个月 130 个）

## 中文简介

用 Cavuno 的 SDK 类型创建自定义的工作板和职业页面 .

## 安装

```sh
npm install @cavuno/board
```

也可以使用：`pnpm add @cavuno/board`、`yarn add @cavuno/board`、`bun add @cavuno/board`

## README

# 卡武诺板 SDK

用 Cavuno 的 SDK 类型创建自定义的工作板和职业页面 .

`@cavuno/board` 是Cavuno Board API的零依赖客户端。 这个 运行在浏览器、节点.js 20 或更新,以及 Cloudflare Workers, 带有类型脚本 由 API 的 OpenAPI 合同产生的声明.

[文档](https://cavuno.com/docs/sdk) • 妇女 [安装](https://cavuno.com/docs/sdk/installing) • 妇女 [SDK 参考](https://cavuno.com/docs/sdk/reference) • 妇女 [API 参考](https://cavuno.com/docs/api) • 妇女 [来源](https://github.com/wollemiahq/cavuno-sdk)

## 安装

### 作为软件包安装

```bash
npm install @cavuno/board
```

该一揽子计划包括无害环境管理和共同联合战略建设。 无害环境管理进口是可树动的, 和帮助软件包,例如 `@cavuno/board/format` 可单独导入.

### 通过 CDN 安装

没有软件包管理器或构建步骤? 跟着 [CDN 安装指南](https://cavuno.com/docs/sdk/installing/cdn) 对一个版本固定的建筑 及其完整性散列。 CDN大楼是 同一个文件下载的 SDK; 软件包导入仍为建议 当它们可用时选择.

见 [安装](https://cavuno.com/docs/sdk/installing) 每个安装选项.

## 快开始

```ts
import { createBoardClient } from '@cavuno/board';

const board = createBoardClient({
  board: 'pk_your_publishable_key',
});

const [context, jobs] = await Promise.all([
  board.context(),
  board.jobs.list({ limit: 20 }),
]);

console.log(context.name);
console.log(jobs.data);
```

A 类 `pk_…` 键可以识别一个面板,并按设计公开。 把它从 **设置 — 开发者 — SDK** 在卡武诺 客户端连接到 `https://api.cavuno.com` 默认.

客户暴露了打入的命名空间 工作和搜索,公司,薪水, 博客 董事会用户认证 保存工作 应用程序 工作提醒, 信息、雇主工作流程、离职、候选人访问和机会均等办公室数据.

## 处理错误

每个非-2xx响应都会发出一个 `BoardApiError` 具有 API 状态,代码, 详细信息,请出示身份证.

```ts
import { BoardApiError, isNotFound } from '@cavuno/board';

try {
  await board.jobs.retrieve('missing-job');
} catch (error) {
  if (isNotFound(error)) {
    // Render your application's not-found state.
  } else if (error instanceof BoardApiError) {
    console.error(error.code, error.requestId);
  }
}
```

见 [处理 SDK 错误](https://cavuno.com/docs/sdk/fundamentals/errors) 页:1 完全错误的合同和警卫.

## 认证

-   A 类 `pk_…` 可公布的密钥识别板并可能包含在浏览器中 代码.
-   候选人和雇主会议 `board.auth.*`选择浏览器存储 ; 服务器上的应用程序应当将会话保留在它们中 拥有 httply 只有饼干.
-   操作员和管理员证书决不能使用此 SDK 或曝光 到前端代码.

读取 [认证和会话](https://cavuno.com/docs/sdk/fundamentals/authentication-and-session-ownership) 在添加签名工作流程之前.

## 向自定义终点请求

对于没有命名空间方法的终点, `board.client.fetch<T>(path, init)` 使用相同的棋盘基路径、信头、无记名符号、序列化和钩子 作为其余客户. 将通用响应类型作为您的 应用程序的断言; 定制答复不来自公众 OpenAPI合约.

见 [`board.client.fetch()`](https://cavuno.com/docs/sdk/reference/top-level-methods#make-a-request-to-a-custom-endpoint) 选项和实例.

## 用编码代理设置

该软件包包括版本匹配的Codex, Claude Code的代理技能, 光标和其他相容编码代理 :

```bash
npx @cavuno/board setup
```

那就叫你的经纪人用安装的卡武诺板 `cavuno-board-setup` 技术。 见 [设置代理](https://cavuno.com/docs/sdk/installing/agent) 审评和核查工作流程.

## 报告问题

编码代理商(和人员)可以在董事会的API或SDK中报告 能力不足,文件不清,令人惊讶 响应或无益错误。 发送一个 [代理反馈协议v0.1](https://trybackloop.com/spec/) 报告 `POST https://api.cavuno.com/v1/feedback`;不需要证书,而且 发现文件位于 `https://api.cavuno.com/.well-known/agent-feedback`。 。 。 .

```bash
curl https://api.cavuno.com/v1/feedback \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{ "type": "missing_capability", "goal": "What you were trying to do", "message": "What got in the way", "agent": { "name": "my-agent", "model": "model-name" } }'
```

`type`, (中文(简体) ), `goal` 财务报告和审定财务报表 `message` 需要这样做。 每5分钟报告20起. 不包括全权证书或个人资料.

## 资源

-   [SDK 指南和参考](https://cavuno.com/docs/sdk)
-   [董事会API文件](https://cavuno.com/docs/api)
-   [OpenAPI 文档](https://api.cavuno.com/v1/openapi.json)
-   [来源](https://github.com/wollemiahq/cavuno-sdk)
-   [问题](https://github.com/wollemiahq/cavuno-sdk/issues)
-   [TanStack 启动 + shadcn/ ui 工作板模板](https://github.com/wollemiahq/cavuno-tanstack-start-shadcn-job-board-template)

麻省理工学院

### 广告默认

`board.context()` 返回时 `ads.enabled`, (中文(简体) ), `ads.clientId` (Adsense出版社) 身份证) `ads.defaultSlotId` (a Google发行的广告单位ID). 只有当 启用 。 默认重用棋盘已存在 广告设置: 已启用 `jobs:list.footer` 单位优先,否则 使用第一个以字母顺序排列的有效单位。 没有 配置的单位、 已禁用广告或无效的出版商生成无效 默认。 仍然需要谷歌的批准和一个现有的广告股.

你的前端拥有广告位置和大小 重用默认的插入, 或将Google发布的另一个插槽ID传递给单个广告组件;没有 SDK定位注册. 自定义单位仍应尊重 `ads.enabled` 编辑 董事会的同意要求.

## 常见问题

### @cavuno/board 是什么？

用 Cavuno 的 SDK 类型创建自定义的工作板和职业页面 \.

### 如何安装 @cavuno/board？

在项目目录运行 npm install @cavuno/board，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cavuno-board，可以用 npx cavuno-board 直接运行。

### @cavuno/board 支持 TypeScript 吗？

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

### @cavuno/board 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cavuno/board 需要什么版本的 Node\.js？

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

### @cavuno/board 可以商用吗？

@cavuno/board 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cavuno/board 的下载量有多少？

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

### @cavuno/board 还在维护吗？

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