# @cometchat-pro/chat 中文文档

规范地址：https://npmcn.com/package/%40cometchat-pro/chat/

版本：3\.0\.13
npm 元数据更新时间：2026-05-12T10:13:58.619Z
中文译文更新时间：2026-11-10T11:44:34.119Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

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

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

- 包体积（解压后）：504 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-01-14T17:50:14.099Z
- 最新版本发布：2023-07-24T12:04:53.066Z
- 近 30 天下载量：11576（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：145（近 12 个月 0 个）

## 中文简介

完整的聊天解决方案 .

## 安装

```sh
npm install @cometchat-pro/chat
```

也可以使用：`pnpm add @cometchat-pro/chat`、`yarn add @cometchat-pro/chat`、`bun add @cometchat-pro/chat`

## README

![](https://avatars2.githubusercontent.com/u/45484907?s=200&v=4)

  
  

# 彗星Chat Javascript SDK

彗星聊天 Pro 允许您为您的网站和应用程序添加语音,视频和文本聊天. 此指南演示了如何使用CometChat Pro在 WebSite 中添加聊天.

## 特征

-   1-1 组对话( G)
-   语音视频呼叫和电话会议
-   富媒体附件
-   打字指标
-   自定义信件
-   读取收据
-   在线存在指标
-   信件历史
-   单人签名
-   网络呼号
-   瓶装
-   用户朋友列表( F)
-   组列表
-   对话列表
-   线索对话

## 扩展

[推动通知](https://prodocs.cometchat.com/docs/extensions-enhanced-push-notification) | [电子邮件通知](https://prodocs.cometchat.com/docs/extensions-email-notification) | [短消息通知](https://prodocs.cometchat.com/docs/extensions-sms-notification) | [缩略图生成](https://prodocs.cometchat.com/docs/extensions-thumbnail-generation) | [链接预览](https://prodocs.cometchat.com/docs/extensions-link-preview) | [富媒体预览](https://prodocs.cometchat.com/docs/extensions-rich-media-preview) | [语音译名](https://prodocs.cometchat.com/docs/extensions-voice-transcription) | [智能回复](https://prodocs.cometchat.com/docs/extensions-smart-reply) | [信件翻译](https://prodocs.cometchat.com/docs/extensions-message-translation) | [爱莫吉斯](https://prodocs.cometchat.com/docs/extensions-emojis) | [选票](https://prodocs.cometchat.com/docs/extensions-polls) | [反应](https://prodocs.cometchat.com/docs/extensions-reactions) | [贴纸](https://prodocs.cometchat.com/docs/extensions-stickers) | [视频广播](https://prodocs.cometchat.com/docs/extensions-broadcast) | [协作文件](https://prodocs.cometchat.com/docs/extensions-collaborative-document) | [协作白板](https://prodocs.cometchat.com/docs/extensions-collaborative-whiteboard) | [数据遮盖过滤器](https://prodocs.cometchat.com/docs/extensions-data-masking-filter) | [职业过滤器](https://prodocs.cometchat.com/docs/extensions-profanity-filter) | [图像调和](https://prodocs.cometchat.com/docs/extensions-image-moderation)| [感官分析](https://prodocs.cometchat.com/docs/extensions-sentiment-analysis) | [飞行中信件调和](https://prodocs.cometchat.com/docs/extensions-in-flight-message-moderation) | [病毒和恶意软件扫描器](https://prodocs.cometchat.com/docs/extensions-virus-malware-scanner) | [XSS 过滤器](https://prodocs.cometchat.com/docs/extensions-xss-filter)

[![Platform](https://img.shields.io/badge/Platform-Javascript-brightgreen)](https://npmcn.com/package/%40cometchat-pro/chat/#) [![](https://img.shields.io/badge/Version-3.0.11-important)](https://npmcn.com/package/%40cometchat-pro/chat/) ![GitHub repo size](https://img.shields.io/github/repo-size/cometchat-pro/javascript-chat-sdk) ![GitHub contributors](https://img.shields.io/github/contributors/cometchat-pro/javascript-chat-sdk) ![GitHub stars](https://img.shields.io/github/stars/cometchat-pro/javascript-chat-sdk?style=social) ![Twitter Follow](https://img.shields.io/twitter/follow/cometchat?style=social)

* * *

## 先决条件 :

在开始之前,确保您满足以下要求:  
✅Τ [`Visual Studio Code`](https://code.visualstudio.com/) 或安装在机器中的任何其他代码编辑器.  
✅Τ [`npm`](https://www.npmjs.com/get-npm) 安装在您的机器中.  
你读过 [彗星聊天关键概念](https://prodocs.cometchat.com/docs/concepts)。 。 。 .  

* * *

## 安装相机 Javascript SDK

## 设置 :

要设置Javascript SDK,您需要先在CometChat Dashboard上注册. [点击这里注册](https://app.cometchat.com/login)。 。 。 .

### 一,获取您的应用程序密钥: key:

[彗星聊天报名](https://app.cometchat.io/) 并随后:

1.  创建新应用程序: 单击 **添加 App 应用程序** 选项 – 输入 App 名称和其他信息 – 创建 App
2.  在顶部 **快速启动** 你会找到的 **Auth 密钥** 打开 **应用标识** 否则你可以去 **API 和 Auth 密钥** 和注 **Auth 密钥** 财务报告和审定财务报表 **应用标识** ![](https://files.readme.io/4b771c5-qs_copy.jpg)

* * *

### 二. 添加彗星聊天依赖性

-   **通过国家预防机制安装**  
    1\. 运行以下命令以安装 CometChat Pro Javascript SDK  
    
    ```javascript
        npm install @cometchat-pro/chat@3.0.11 --save
    ```
    
-   **通过 CDN 导入**  
    1\. 将CometChat Pro Javascript库纳入您的 HTML 代码.  
    
    ```html
      <script type="text/javascript" src="https://unpkg.com/@cometchat-pro/chat@3.0.11/CometChat.js"></script>
    ```
    
    有关如何这样做的说明可参见以下链接:  
    [++ 添加彗星聊天依赖性](https://prodocs.cometchat.com/docs/js-quick-start#add-the-cometchat-dependency)
    

* * *

## 配置相机 Javascript SDK

### 一. 启动彗星聊天

我们建议您在应用程序启动时使用init()方法, 最好是在index.js文件中 .

```javascript
var appID = "APP_ID";
var region = "REGION";
var appSetting = new CometChat.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).build();
CometChat.init(appID, appSetting).then(
  () => {
    console.log("Initialization completed successfully");
  },
  error => {
    console.log("Initialization failed with error:", error);
  }
);
```

| : 信息 来源 :   **注:确保替换 `region` 财务报告和审定财务报表 `appID` 带着你的证书.** |
| --- |

### 二. 创建用户QQ

一旦初始化成功,您需要创建用户 。 您需要使用创建 User () 方法在苍蝇上创建用户 .

```javascript
let authKey = "AUTH_KEY";
var uid = "user1";
var name = "Kevin";

var user = new CometChat.User(uid);

user.setName(name);

CometChat.createUser(user, authKey).then(
  user => {
    console.log("user created", user);
  },error => {
    console.log("error", error);
  }
);
```

> : 信息 来源 : **注意: 确保指定UID和名称,因为这些是创建用户的强制字段 .**

* * *

### 页:1 登录用户QQ

一旦您成功创建了用户, 您就需要使用登录方法将用户登录到CometChat中 .

```javascript
var UID = "SUPERHERO1";
var authKey = "AUTH_KEY";

CometChat.getLoggedinUser().then(
  user => {
    if(!user){
      CometChat.login(UID, authKey).then(
        user => {
          console.log("Login Successful:", { user });    
        },
        error => {
          console.log("Login failed with exception:", { error });    
        }
      );
    }else{
      // User already logged in
    }
  }, error => {
    console.log("getLoggedinUser failed with exception:", { error });
  }
);
```

| : 信息 来源 :   **说明- 登录方法只需调用一次 。 同时将 AUTH KEY 替换为您的 App Auth 键 .** |
| --- |

* * *

请参考我们 [开发者文档](https://prodocs.cometchat.com/docs/js-quick-start) 用于提供更多信息,说明如何配置CometChat Pro SDK并使用同一功能实施各种特性.

* * *

## 更多地了解UI- Kit

[角形UI Kit 软件](https://github.com/cometchat-pro/javascript-angular-chat-ui-kit) | [反应 UI Kit](https://github.com/cometchat-pro/javascript-react-chat-ui-kit) | [Vue UI Kit 软件](https://github.com/cometchat-pro/javascript-vue-chat-ui-kit)

## 贡献者 :

感谢为该项目作出贡献的下列人士: [@ajaygajra:你对我的爱心](https://github.com/ajaygajra) [@ mayur-bhandari (英语)](https://github.com/mayur-bhandari)

* * *

## 联系人: mailbox :

通过实时支援联系我们 [彗星Chat Dashboard. (原始内容存档于2018-09-29).](https://app.cometchat.io/)

* * *

## 常见问题

### @cometchat-pro/chat 是什么？

完整的聊天解决方案 \.

### 如何安装 @cometchat-pro/chat？

在项目目录运行 npm install @cometchat-pro/chat，或使用 pnpm add / yarn add / bun add。

### @cometchat-pro/chat 支持 TypeScript 吗？

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

### @cometchat-pro/chat 支持 ESM 还是 CommonJS？

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

### @cometchat-pro/chat 可以商用吗？

@cometchat-pro/chat 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @cometchat-pro/chat 的下载量有多少？

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

### @cometchat-pro/chat 还在维护吗？

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