# @coveo/headless 中文文档

规范地址：https://npmcn.com/package/%40coveo/headless/

版本：3\.58\.1
npm 元数据更新时间：2026-11-02T20:44:34.532Z
中文译文更新时间：2026-11-10T20:57:00.949Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40coveo/headless
原文对照：https://npmcn.com/package/%40coveo/headless/?lang=original
项目主页：https://docs.coveo.com/en/headless/latest/
源码仓库：https://github.com/coveo/ui-kit

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

- 包体积（解压后）：39.8 MB，2430 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^20\.9\.0 \|\| ^22\.11\.0 \|\| ^24\.11\.0
- 运行依赖：15 个
- peer 依赖：typescript \>=5\.0\.0，pino-pretty ^6\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0 \|\| ^13\.0\.0
- 首次发布：2020-07-23T13:09:09.218Z
- 最新版本发布：2026-11-02T20:44:34.186Z
- 近 30 天下载量：383412（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：4004（近 12 个月 54 个）

## 中文简介

在 Coveo 平台建立搜索经验的无头图书馆

## 安装

```sh
npm install @coveo/headless
```

也可以使用：`pnpm add @coveo/headless`、`yarn add @coveo/headless`、`bun add @coveo/headless`

## README

* * *

## 标题: 贡献 组: 贡献

[![npm version](https://badge.fury.io/js/@coveo%2Fheadless.svg)](https://badge.fury.io/js/@coveo%2Fheadless)

# 科维奥无头

使用图书馆: [Coveo 无头图书馆 正式文件](https://docs.coveo.com/en/headless/latest/)。 。 。 .

## 入境点

这个 `@coveo/headless` 软件包会显示几个切入点.

导入 Coveo 头部资源的切入点取决于您使用的引擎类型 :

| 引擎类型 | 入境点 |
| --- | --- |
| 搜索引擎 | `@coveo/headless` |
| 搜索 SSR 引擎 | `@coveo/headless/ssr` |
| 搜索 SSR 引擎( 打开 alpha) | `@coveo/headless/ssr-next` |
| 大小写引擎 | `@coveo/headless/case-assist` |
| 商业引擎 | `@coveo/headless/commerce` |
| 商务SSR引擎(开放β) | `@coveo/headless/ssr-commerce` |
| 商务SSS引擎(开放的alpha) | `@coveo/headless/ssr-commerce-next` |
| 透视引擎 | `@coveo/headless/insight` |
| 建议引擎 | `@coveo/headless/recommendation` |

## 捐款

### 开始

复制后,请遵守顶级指令 [读取](https://github.com/coveo/ui-kit/blob/main/README.md) 以安装依赖和链接软件包.

要以开发模式启动项目, 运行:

```bash
pnpm run dev
```

为了建设用于制作的图书馆,运行:

```bash
pnpm run build
```

运行单元测试,运行:

```bash
pnpm test
```

要运行单元测试和观看,运行:

```bash
pnpm run test:watch
```

要在当地使用@coveo/无头, 您必须运行来构建软件包 :

```bash
pnpm run build
```

### 复数

无头项目密集使用 ["红花"](https://redux.js.org/) 和 [“红外工具箱”](https://redux-toolkit.js.org/),所以必须事先知道.

### 源文件夹结构

基础 `/src` 文件夹只应包含导出.

`/ssr` 包含所有与服务器侧渲染( SSR) 引擎和控制器相关的逻辑和类型

`/app` 包含全应用程序设置: Redux store, root 剪接器, 中间软件.

`/state` 包含各种应用程序状态的界面.

`/features` 有文件夹,每个文件夹都拥有一个特性的功能,这是redux状态的一个子部分。 紧接着 ["教育模式"](https://redux.js.org/style-guide/style-guide#structure-files-as-feature-folders-or-ducks),这些文件中包含 Redux 切片并减小其 [定义状态形状](https://redux.js.org/style-guide/style-guide#reducers-should-own-the-state-shape)。每个特性文件夹都有一个文件,其中包含可以与项目一起导出的行动.

`/controllers` 在文件夹中包含所有无头控制器。 这些控制器通过接近客户应用程序的实际UI控制器,被导出并用于提供从商店特性上取出抽象.

`/utils` 包含共同有用的公用事业.

`/api` 包含一切关于api呼叫.

`/test` 包含测试模拟.

# 贡献指南:新增控制器.

请看 [贡献指南](https://npmcn.com/package/%40coveo/headless/contributors/adding-a-controller.md) 用于指导.

# 贡献指南:解答捆绑内容出问题.

请看 [贡献指南](https://npmcn.com/package/%40coveo/headless/contributors/troubleshooting-bundles-content.md) 用于指导.

## 常见问题

### @coveo/headless 是什么？

在 Coveo 平台建立搜索经验的无头图书馆

### 如何安装 @coveo/headless？

在项目目录运行 npm install @coveo/headless，或使用 pnpm add / yarn add / bun add。

### @coveo/headless 支持 TypeScript 吗？

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

### @coveo/headless 支持 ESM 还是 CommonJS？

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

### @coveo/headless 需要什么版本的 Node\.js？

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

### @coveo/headless 可以商用吗？

@coveo/headless 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @coveo/headless 的下载量有多少？

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

### @coveo/headless 还在维护吗？

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