# @chamaeleonidae/chmln 中文文档

规范地址：https://npmcn.com/package/%40chamaeleonidae/chmln/

版本：1\.0\.1
npm 元数据更新时间：2026-04-09T16:01:10.276Z
中文译文更新时间：2026-11-09T09:58:58.258Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：18.5 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2021-08-18T22:14:13.514Z
- 最新版本发布：2022-06-10T16:36:34.621Z
- 近 30 天下载量：942957（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

官方变色龙. io JavaScript 客户端库

## 安装

```sh
npm install @chamaeleonidae/chmln
```

也可以使用：`pnpm add @chamaeleonidae/chmln`、`yarn add @chamaeleonidae/chmln`、`bun add @chamaeleonidae/chmln`

## README

# 变色龙 JavaScript 库

易地将变色龙加入你的产品!

Chameleon JavaScript 库是一套附在全局上的方法 `chmln` 用于应用程序向用户显示变色龙经验的对象.

## 通过国家预防机制安装

该图书馆可作为一个关于国家预防机制的软件包提供。 利用国家防范机制安装前端包装器,如Webpack或浏览器,将其安装到一个项目中:

```
  npm install --save @chamaeleonidae/chmln
```

你可以拿着你的 [符号](https://app.chameleon.io/setup/install) 然后像标准节点.js模块一样要求 lib :

```javascript
const chmln = require('@chamaeleonidae/chmln');

chmln.init('YOUR_TOKEN', { fastUrl: 'https://fast.chameleon.io/' });
```

> 前所创建的账户的说明 _2022-05-21 (英语)_ 您必须省略快件 Url 如果你不确定, 核实您的账户特定指示 [安装页面](https://app.chameleon.io/setup/install)。 。 。 .

```javascript
chmln.init('YOUR_TOKEN');
```

> 使用变色龙作为第一当事方(即通过 `chameleon.your-product.com`),第一个 [联系我们](https://app.chameleon.io/help) 设置此选项,然后使用此自定义域的更新脚本.

```javascript
chmln.init('YOUR_TOKEN', { fastUrl: 'https://chameleon.your-product.com/' }); // << CHANGE ME
```

## 使用量

首先遵循上面的安装过程. 脚本同步加载, 不会影响您的页面加载时间 .

接下来,通过发送一个独特的ID来识别您的用户(这通常与数据库中的UID匹配). Chameleon无法向用户展示经验。 你也应该 [发送额外的用户数据](https://help.trychameleon.com/en/articles/1226443-how-do-i-send-my-users-data-to-chameleon) (例如“电子邮件地址”、“作用”)或公司数据(例如“计划类型”、“子域”),因此,您可以在适当的时间将经验瞄准正确的用户.

```javascript
chmln.identify(USER.ID_IN_DB, {     // REQUIRED Unique ID of each user in your database (e.g. 23443 or "590b80e5f433ea81b96c9bf6")
  email: USER.EMAIL,                // RECOMMENDED Used to connect data coming from various integrations

  // SUGGESTED - User properties:
  created: USER.SIGN_UP_DATE,       // Send dates in ISO or unix timestamp format (e.g. "2017-07-01T03:21:10Z" or 1431432000)
  name: USER.NAME,                  // We will parse this to extra first and surnames (e.g. "James Doe")
  role: USER.ROLE,                  // Send properties useful for targeting types of users (e.g. "Admin")
  logins: USER.LOGIN_COUNT,         // Send any data about user engagement (e.g. 39)
  project: USER.PROJECT_ID,         // Send any unique data for a user that might appear in any page URLs (e.g. 09876 or "12a34b56")

  // OPTIONAL - Company properties:
  company: {                        // For B2B products, send company / account information here
    uid: COMPANY.ID_IN_DB,          // Unique ID of the company / account in your database (e.g. 9832 or "590b80e5f433ea81b96c9bf7")
    created: COMPANY.SIGN_UP_DATE,  // To enable targeting all users based on this company property
    name: COMPANY.NAME,             // Send any data that appears within URLs, such as subdomains (e.g. "airbnb")
    trial_ends: COMPANY.TRIAL_ENDS, // Send data about key milestones (e.g. "2017-08-01T03:21:10Z")
    version: COMPANY.VERSION,       // If your software varies by version then this will help show the correct guidance (e.g. "1.56")
    plan: COMPANY.PLAN,             // Send null when no value exists (e.g. "Gold", "Advanced")
    spend: COMPANY.CLV              // Send other properties that will help in targeting users (e.g. sales rep, source, stage)
  }
});
```

您可以选择跟踪用户事件:

```javascript
chmln.track(PLAN_CHANGED);          // Example event "PLAN_CHANGED" can be used for targeting or measuring success
chmln.track(ACTIVATED);             // Having a defined activation point can be helpful for targeting onboarding experiences.
```

## 常见问题

### @chamaeleonidae/chmln 是什么？

官方变色龙\. io JavaScript 客户端库

### 如何安装 @chamaeleonidae/chmln？

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

### @chamaeleonidae/chmln 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chamaeleonidae\_\_chmln 是否存在。

### @chamaeleonidae/chmln 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @chamaeleonidae/chmln 可以商用吗？

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

### @chamaeleonidae/chmln 的下载量有多少？

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

### @chamaeleonidae/chmln 还在维护吗？

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