Pusher Channels JavaScript 客户端技术文档

本文档旨在帮助用户安装、使用Pusher Channels JavaScript客户端库，并详细介绍其API的使用方法。

1. 安装指南

Web环境

在Web页面中使用Pusher Channels，可以通过以下方式安装：

使用Yarn或NPM

yarn add pusher-js

然后在JavaScript代码中导入：

import Pusher from 'pusher-js';

如果需要使用加密通道：

import Pusher from 'pusher-js/with-encryption';

或者，如果不使用ES6模块：

const Pusher = require('pusher-js');

如果需要使用加密通道：

const Pusher = require('pusher-js/with-encryption');

使用CDN

在HTML页面中直接引用：

<script src="https://js.pusher.com/7.0/pusher.min.js"></script>

如果需要使用加密通道：

<script src="https://js.pusher.com/7.0/pusher-with-encryption.min.js"></script>

使用Bower（不推荐）

或者通过Bower安装：

bower install pusher

然后：

<script src="bower_components/pusher/dist/web/pusher.min.js"></script>

Typescript

从v5.1.0版本开始，提供了TypeScript声明。大多数内容开箱即用，但如果需要访问特定类型，可以按以下方式导入：

import Pusher from 'pusher-js';
import * as PusherTypes from 'pusher-js';

React Native

React Native支持已被弃用，并将从库中移除。请使用我们的官方React Native SDK。

Web Workers

Pusher.js的Web Workers实现目前不兼容Internet Explorer。

从CDN导入worker脚本：

importScripts('https://js.pusher.com/7.0/pusher.worker.min.js');

如果需要使用加密通道：

importScripts('https://js.pusher.com/7.0/pusher-with-encryption.worker.min.js');

Node.js

通过NPM兼容的包管理器安装pusher-js后，运行：

import Pusher from 'pusher-js';

2. 使用说明

初始化Pusher客户端：

const pusher = new Pusher(APP_KEY, {
  cluster: APP_CLUSTER,
});

您可以从Pusher Channels仪表板获取APP_KEY和APP_CLUSTER。

3. 项目API使用文档

以下是Pusher Channels JavaScript客户端的主要API使用方法。

初始化

const pusher = new Pusher(APP_KEY, {
  cluster: APP_CLUSTER,
  // 其他配置项
});

订阅频道

const channel = pusher.subscribe('my-channel');

绑定事件

channel.bind('my-event', function(data) {
  console.log(data);
});

默认事件

Pusher Channels有一些默认事件，例如pusher:connection_established。

用户认证

用户认证配置对象包含以下有效键：

• endpoint：认证签名所需的端点。
• transport：定义如何调用认证端点。
• params：发送到认证端点的附加参数。
• headers：发送到认证端点的附加HTTP头。

更多详情请参考用户认证文档。

4. 项目安装方式

请参考上文“安装指南”部分，了解如何在不同的环境中安装Pusher Channels JavaScript客户端库。

以上是Pusher Channels JavaScript客户端库的技术文档，希望对您的开发有所帮助。