# x-websocket

> Easy Websocket Client Package

Latest version **1.1.2** (published 2023-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install x-websocket
pnpm add x-websocket
yarn add x-websocket
bun add x-websocket
```

## 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.2 |
| Published | 2023-08-14 |
| First published | 2021-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 87.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | mikexia930 |
| Keywords | websocket, socket |

## Links

- npm: https://www.npmjs.com/package/x-websocket
- npm.io page: https://npm.io/package/x-websocket

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2023-08-14
- 1.1.1 — 2023-03-29
- 1.1.0 — 2022-10-08
- 1.0.5 — 2021-07-29
- 1.0.4 — 2021-07-29
- 1.0.3 — 2021-06-17
- 1.0.2 — 2021-06-17
- 1.0.1 — 2021-06-17
- 1.0.0 — 2021-06-16

## README

# x-websocket
>
>WebSocket的前端封装。
> 
>消息发送，采用队列模式，避免open和error时候，上报的数据丢失。
> 
> 内置的心跳采用定时器，可以设置time为0，不使用内置心跳。
>
[Demo](https://mikexia930.github.io/xWebsocket/)
## 版本
- v1.1.0

## 基于
- websocket

## 安装
```
npm install x-websocket
```
或者
```
github下载源码
```
## 使用
**直接用script引入**
```
<script src="xWebsocket/lib/xwebsocket.umd.js"></script>
```
#### Vue示例
**在main.js引入**
```
import XWebsocketd from 'x-websocket';
```
**挂载到Vue原型上**
```
Vue.prototype.XWebsocket = new XWebSocket(
  参数1：socket地址,
  参数2：协议protocols ｜ null,
  参数3：重连次数，默认10（数值类型，错误重试次数）,
  参数4：心跳设置 {
    time: 5 （数值类型，单位/秒，心跳发送次数，为0表示不自动发送心跳）,
    message: 'heartbeat' （字符串类型，心跳上报的内容）,
  } （heartbeat配置),
);
```

**在组件中使用，建立连接**
```
// 可以不传也可以使用socketUrl参数覆盖new时候的socket地址
try {
    this.XWebsocket.getSocketIns(socketUrl?, handleMessage?);
} catch (err) {
    console.log('socket:', err);
}

// handleMessage 为初始接收消息的处理函数 (message) => { 处理接收的信息 }，可不填
//  * 不填需要手动设置 this.XWebsocket.getMessage
//  * this.XWebsocket.getMessage 不会捕获上报的 ping 和 onclose 消息。
// 上报的ping 和 onclose 信息也会被封装在 message里，通过 message.type 获取 ping / close
function handleMessage(message) {
    const { type, data } = message;
    switch(type) {
        case 'ping':
            // 上报的 ping 数据
            break;
        case 'close':
            // onclose 触发
            break;
        default:
            // 接收的数据
            break;
    }
}
```

**发送消息**
```
this.XWebsocket.sendMessage(消息内容);
```

**接收消息**
```
this.XWebsocket.getMessage((message) => {
  接收的消息
});
```
**关闭连接**
```
this.XWebsocket.close();
```
**获取当前状态**
```
this.XWebsocket.getState(); // undefined：无实例，0：连接中 1：已连接 2：关闭中 3：已关闭
```
**销毁当前实例**
```
this.XWebsocket.destroy();
```

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