# rtes-client

> ``` # 安装客户端包 npm install rtes-client --save ```

Latest version **1.1.0** (published 2024-03-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install rtes-client
pnpm add rtes-client
yarn add rtes-client
bun add rtes-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-03-13 |
| First published | 2021-04-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | fengcai.li |

## Links

- npm: https://www.npmjs.com/package/rtes-client
- npm.io page: https://npm.io/package/rtes-client

## Dependencies (1)

- [sse.js](https://npm.io/package/sse.js.md) ^0.5.0

## Recent versions

- 1.1.0 (latest) — 2024-03-13
- 1.0.3 — 2021-04-15
- 1.0.5 — 2021-04-15
- 1.0.4 — 2021-04-15

## README

# 会话/事件服务 JavaScript 客户端

## 1.使用指南
### 1.1 准备事项

```
# 安装客户端包
npm install rtes-client --save
```

### 1.2 示例代码

#### 1.2.1 建立会话

```
import RtesClient from "rtes-client";

// 新建客户端
var accessToken = "...";    // SSO 的 AccessToken

// 设置 OAuth 的 AccessToken 请求头与查询参数（当使有 WebSocket 模式时，只能把 AccessToken 放进查询参数中）
// 选项中的 mode 可以设为 WebSocket 或 SSE 模式
var options = {       
  headers: {"Authorization": "Bearer " + accessToken },
  query: {
  	"access_token": accessToken
  },
  mode: "WebSocket",
  platform: "MP-WEIXIN" // 平台名称,当platform的值是"MP-WEIXIN",mode只能是"WebSocket"
};
let rtesClient = new RtesClient("http://localhost:7263/session", options);

// 打开会话
let session = rtesClient.open([["team=*", "event=*"]]);

// 监听连接成功事件
session.addListener("connected", () => {
  console.log("connected");
});

// 监听断连事件
session.addListener("disconnected", () => {
  console.log("disconnected");
});

// 监听消息事件
session.addListener("message", (event) => {
  console.log(event);
});
```

#### 1.2.2 关闭会话

```
// 当确定不需要收接事件时，则可以关闭会话，释放资源
...
session.close();
```

### 2. 版本发布

### 2.1 设置仓库地址

```
npm config set registry http://registry.npmjs.org 
```

### 2.2 登录 NPM 帐号

必须要先在 https://www.npmjs.com/ 注册开发者帐号

```
npm login
```

### 2.3 发布版本

同一个版本只能发布一次，所以每次发布必须在 package.json 修改版本号

```
npm publish
```

---
_Source: https://npm.io/package/rtes-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._