@coveo/headless

中文文档
3.58.1发布于 2026/11/03Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 38.3万

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

中文使用文档
文档目录6 节
  1. 标题: 贡献 组: 贡献
  2. 入境点
  3. 捐款
  4. 开始
  5. 复数
  6. 源文件夹结构

标题: 贡献 组: 贡献

npm version

科维奥无头

使用图书馆: Coveo 无头图书馆 正式文件。 。 。 .

入境点

这个 @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

捐款

开始

复制后,请遵守顶级指令 读取 以安装依赖和链接软件包.

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

pnpm run dev

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

pnpm run build

运行单元测试,运行:

pnpm test

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

pnpm run test:watch

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

pnpm run build

复数

无头项目密集使用 "红花" 和 “红外工具箱”,所以必须事先知道.

源文件夹结构

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

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

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

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

/features 有文件夹,每个文件夹都拥有一个特性的功能,这是redux状态的一个子部分。 紧接着 "教育模式",这些文件中包含 Redux 切片并减小其 定义状态形状。每个特性文件夹都有一个文件,其中包含可以与项目一起导出的行动.

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

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

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

/test 包含测试模拟.

贡献指南:新增控制器.

请看 贡献指南 用于指导.

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

请看 贡献指南 用于指导.

版本与发布记录

@coveo/headless 共发布 4,004 个版本,首次发布于 2020/07/23;过去 12 个月发布了 54 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.58.1latest2026/11/038 天前
3.58.02026/10/2022 天前
3.57.32026/10/1428 天前
3.57.22026/10/061 个月前
3.57.12026/09/301 个月前
3.57.02026/09/231 个月前

其他发布通道:v2-latest → 2.80.7。

关于 @coveo/headless 的常见问题

@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 和提交记录判断。