https://github.com/yisibell/myws

A tiny websocket client library.
https://github.com/yisibell/myws

mitt vue vue-plugin websocket websocket-client

Last synced: 3 months ago
JSON representation

A tiny websocket client library.

• Host: GitHub
• URL: https://github.com/yisibell/myws
• Owner: yisibell
• License: mit
• Created: 2022-01-18T03:37:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-23T07:19:55.000Z (6 months ago)
• Last Synced: 2024-09-24T05:47:57.405Z (4 months ago)
• Topics: mitt, vue, vue-plugin, websocket, websocket-client
• Language: TypeScript
• Homepage:
• Size: 224 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  

    

  

  

    

  

  




# myws

A tiny websocket client library.

- [Release Notes](./CHANGELOG.md).

# Features

- Automatically reconnect when websocket fails.

- Support event subscription mode, receive messages by listening to events.

- Support **Typescript**.

# Installation

```bash

# pnpm

$ pnpm add myws

# yarn

$ yarn add myws

# npm

$ npm i myws

```

# Basic Usage

``` ts

import { initMyws } from 'myws'

let mywsInstance = initMyws({

  open: ture,

  api: 'wss://server/some/path',

  // ...

}, (wsInstance) => {

  // 想要自动重连功能有效的话，你需要使用该回调函数对 ws 示例对象进行赋值更新。

  mywsInstance = wsInstance

})

```

# In Vue2

> **TIPS**: 该方式已不再推荐使用，请使用 `initMyws` 替代。

``` ts

import Vue from 'vue'

import { wsInstaller } from 'myws'

Vue.use(wsInstaller, {

  open: true,

  api: 'wss://server/some/path'

  // ...

})

```

# Ws Instance 

初始化 `WebSocket` 后，会返回一个 `wsInstance` 示例对象。该对象包含以下几个属性。

1. `WS` : 即，`new WebSocket()` 返回的示例对象。

2. `WsBus` : 则是一个事件总线，由 `mitt` 实例化而来，你可以使用它监听 `WebSocket` 的消息。

3. `connected` : (`boolean`) 表示 `WebSocket` 是否已完成连接。

# Options

| Key | Type | Default Value | Description  |

| :---: | :---: | :---: | :---:  |

| `open` | `boolean`, `string`, `number` | `true` | 是否开启 ws |

| `api` |  `string` | - |  ws 服务地址 |

| `protocols` |  `string`, `string[]` | `undefined` |  一个协议字符串或者一个包含协议字符串的数组。 |

| `heart_interval` |  `number` | `50000` | ws 心跳间隔，毫秒数。 |

| `heart_data` |  `() => any` | `undefined` | ws 心跳时传递的参数。 |

| `reconnect_interval` |  `number` | `3000` | ws 重连间隔，毫秒数。 |

| `reconnect_limit` |  `number` | `30` | 自动重连次数限制。|

| `reconnect_limit_msg` |  `string` | - | 超出重连次数时的提示文本。|

| `reconnect_msg` |  `string`, `(count: number) => string` | - | 每次尝试重连 ws 时的提示文本, 也可以是一个函数，该函数会被传入当前的重连计数。|

| `ws_bus_emit_names` |  `Record` | - | 自定义在响应 ws 消息时，WsBus 的 emit 事件名。|

| `onmessage` |  `(data: any) => void` | - | 接收 message 时回调。|

| `onopen` |  `(e: Event) => void` | - | WebSocket 连接时回调。|

| `onerror` |  `(e: Event) => void` | - | WebSocket 出错时回调。|

| `onclose` |  `(e: Event) => void` | - | WebSocket 关闭时回调。|