# cloudsocket

**Repository Path**: orange-studio/cloudsocket

## Basic Information

- **Project Name**: cloudsocket
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-21
- **Last Updated**: 2022-04-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cloudSocket

### 描述
  一个前端websocket客户端集成工具

### 初始化配置
|配置名|类型|示例值|描述|
|:----|:----|:----|:----|
|url            |`string` |ws://127.0.0.1:8199/cloud/ws | 连接地址               |
|query          |`object` |{token:"token"}              | 连接参数               |
|initMsg        |`string` |"初始化消息发送"               | 初始化消息发送           |
|reConnection   |`boole`  |true                         | 断线是否自动连接         |
|reConnWaitTime |`int`    |5000                         | 断线重连等待时长         |
|reConnTime     |`int`    |0                            | 断线重连次数 0、无限重连  |
|isHeart        |`boole`  |false                        | 是否开启心跳            |
|heartWait      |`int`    |10000                        | 心跳等待时间            |
|isLocalStorage |`boole`  |false                        |消息是否存储在LocalStorage|

### 使用实例
```javascript
import cloudSocket from "cloudSocket"

// 初始化方法类
var SocketObj = new cloudSocket.Socket({
  "url":"ws://127.0.0.1:8199/cloud/ws",   // 连接地址
  "query":{
    token:"123123"
  },                                      // 连接参数
  "initMsg":"cs",                         // 初始化消息发送
  "reConnection":true,                    // 断线是否自动连接
  "reConnWaitTime":5000,                  // 断线重练等待时长
  "reConnTime":4,                         // 断线重连次数 0、无限重连
  "isHeart":true,                         // 是否开启心跳
  "heartWait":3000,                       // 心跳等待时间
  "sendTimeOut":10000,                    // 设置发送消息超时时间
  "isLocalStorage":false                  // 消息是否存储在LocalStorage
});

// 连接websocekt并回调消息内容
SocketObj.Conn(function(message){
  console.log(message)
});

// 发送消息返回发送结果 【true,false】
var sendRes = SocketObj.send("send message content")

// 获取存储在LocalStorage历史消息
var historyData = SocketObj.getHistoryLocalStorage()

console.log(sendRes)

```