# @constructor-io/constructorio-client-javascript 中文文档

规范地址：https://npmcn.com/package/%40constructor-io/constructorio-client-javascript/

版本：2\.94\.1
npm 元数据更新时间：2026-11-10T00:36:05.709Z
中文译文更新时间：2026-11-10T16:14:35.485Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.1 MB，38 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@babel/runtime ^7\.19\.0
- 首次发布：2019-09-20T19:57:48.705Z
- 最新版本发布：2026-11-10T00:36:05.506Z
- 近 30 天下载量：94719（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：274（近 12 个月 42 个）

## 中文简介

构造器.io JavaScript 客户端

## 安装

```sh
npm install @constructor-io/constructorio-client-javascript
```

也可以使用：`pnpm add @constructor-io/constructorio-client-javascript`、`yarn add @constructor-io/constructorio-client-javascript`、`bun add @constructor-io/constructorio-client-javascript`

## README

# 构造器.io JavaScript 客户端

[![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-client-javascript)](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-client-javascript/blob/master/LICENSE) [![Minzipped Size](https://img.shields.io/bundlephobia/minzip/@constructor-io/constructorio-client-javascript)](https://bundlephobia.com/result?p=@constructor-io/constructorio-client-javascript)

JavaScript 客户端 [构造器.io](http://constructor.io/)。 。 。 . [构造器.io](http://constructor.io/) 提供搜索作为一种服务,利用人工智能优化结果(包括自然语言处理,重新排序以优化转换,以及用户个性化).

> 此客户端旨在用于浏览器环境中,但也可用于基于React Industrial的移动应用程序. 关于在反照原生情况下的利用的更多信息,可在 [维基](https://github.com/Constructor-io/constructorio-client-javascript/wiki/Utilization-in-a-DOM-less-environment)。如果想要JavaScript客户端用于服务器侧集成,请使用 [@ 构造- io/ 构造- 节点](https://github.com/Constructor-io/constructorio-node)

## 文档

API 文档全文可见于 [Github 页面](https://constructor-io.github.io/constructorio-client-javascript/index.html)

## 1\. 安装

此软件包可以通过 npm 安装 : `npm i @constructor-io/constructorio-client-javascript`。安装后,只需将软件包导入或要求输入您的仓库.

或者,由单个 JavaScript 文件组成的捆绑版本会在 `./dist` 关于 Github 的文件夹。 如果本地主机 - - _请不要直接链接到 Github 主机版本_。 。 。 .

**重要**: 此库只应在客户端的背景中使用, 客户端使用标准的 HTTP 请求头( E) `User-Agent`, (中文(简体) ), `Referer`(见a/c.5/49/70,附件).

## 2\. 获取 API 密钥

你可以从你身上找到这个 [构造器.io仪表板](https://app.constructor.io/dashboard)联系销售,如果你想注册, 或支持 如果你相信你的公司已经有一个账户.

## 3\. 执行客户

一旦导入,可以创建一个客户端实例如下:

```javascript
const ConstructorioClient = require('@constructor-io/constructorio-client-javascript');

const constructorio = new ConstructorioClient({
    apiKey: 'YOUR API KEY',
});
```

## 4\. 获取结果

在即兴播放客户端实例后,七个模块会作为属性被曝光来帮助检索数据或发送行为事件: `search`, (中文(简体) ), `browse`, (中文(简体) ), `autocomplete`, (中文(简体) ), `recommendations`, (中文(简体) ), `quizzes`, (中文(简体) ), `agent`,以及 `tracker`。 。 。 .

### AI 购物代理和产品透视代理

-   [`agent`](https://constructor-io.github.io/constructorio-client-javascript/module-agent.html) 检索AI购物代理(ASA)结果为一流.
-   [`agent.pia`](https://constructor-io.github.io/constructorio-client-javascript/module-pia.html) 检索产品透视代理(PIA)问答.
-   [`tracker`](https://constructor-io.github.io/constructorio-client-javascript/module-tracker.html) 拥有 `trackAgent*` aSA事件和 `trackProductInsightsAgent*` pIA事件的方法.

#### 说明:

1.  这个 `assistant` 名称空间已贬值。 使用 `agent` 换句话说.
    
2.  `agent` 通过浏览器接收结果 `EventSource` 接口。 本地反应不包括 `EventSource`。如果您使用 `agent` 在“反应土著”中,添加一个 `EventSource` 混合填充剂.
    

### 调度活动

模块可能在浏览器上发送自定义事件 `window` 与请求完成时的响应数据。 事件名称遵循以下结构: 1 `cio.client.[moduleName].[methodName].completed`。消费代码如下:

```javascript
window.addEventListener('cio.client.search.getSearchResults.completed', (event) => {
  // `event.detail` will be response data
}, false);
```

## 开发/ npm 命令

```bash
npm run prepare       # one-time after cloning: install husky git hooks (pre-push lint)
npm run lint          # run lint on source code and tests
npm run test          # run tests
npm run coverage      # run tests and serves coverage reports from localhost:8081
npm run docs          # output documentation to `./docs` directory

npm version <patch|minor|major> --ignore-scripts=false   # bump version (see note below)
```

> **说明:** `.npmrc` 套装 `ignore-scripts=true` 用于供应链安全,因此生命周期脚本不会自动运行. 这影响到两个工作流程:
> 
> -   **胡斯基接钩:** 运行 `npm run prepare` 克隆后一次,以便 `pre-push` 灵钩.
> -   **`npm version`数字 :** 页:1 `version` 生命周期脚本( 重生) `src/version.js`文档和 `./dist` 将他们捆绑起来放入释放中)被跳出. 总是通过 `--ignore-scripts=false` 当这个版本被撞倒时 这些文物就会被重新生成.

## 常见问题

### @constructor-io/constructorio-client-javascript 是什么？

构造器\.io JavaScript 客户端

### 如何安装 @constructor-io/constructorio-client-javascript？

在项目目录运行 npm install @constructor-io/constructorio-client-javascript，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@babel/runtime（^7\.19\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @constructor-io/constructorio-client-javascript 支持 TypeScript 吗？

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

### @constructor-io/constructorio-client-javascript 支持 ESM 还是 CommonJS？

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

### @constructor-io/constructorio-client-javascript 可以商用吗？

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

### @constructor-io/constructorio-client-javascript 的下载量有多少？

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

### @constructor-io/constructorio-client-javascript 还在维护吗？

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