https://github.com/costaq/socketjs-client
websocket / typescript
https://github.com/costaq/socketjs-client
typescript websocket
Last synced: about 2 months ago
JSON representation
websocket / typescript
- Host: GitHub
- URL: https://github.com/costaq/socketjs-client
- Owner: costaq
- Created: 2022-10-25T06:50:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-28T07:45:03.000Z (over 3 years ago)
- Last Synced: 2025-12-04T16:54:14.551Z (7 months ago)
- Topics: typescript, websocket
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# socketjs-client
websocket / typescript
## Installation
`npm i -D socketjs-client`
## Basic Usage
```ts
// 基础使用
import Socket from 'socketjs-client';
const options = {
url: 'ws://localhost:8099/ws', // 必填，链接的通道的地址
heartTime: 5000, // 必填，心跳时间间隔（毫秒）
reconnectTime: 5000, // 非必填，默认5000，重连时间间隔（毫秒）
reconnectCount: 5 // 非必填，默认5，重连次数，-1则不限制
};
new Socket(options);
// 销毁
const socket = new Socket(options);
socket.destroy();
// 自定义回调(可额外处理业务上其他逻辑)
const options = {
url: 'ws://localhost:8099/ws',
heartTime: 5000,
openCallback: () => {}, // 连接成功的回调
closeCallback: () => {}, // 连接关闭的回调
messageCallback: () => {}, // 收到消息的回调
errorCallback: () => {}, // 发生错误的回调
};
new Socket(options);
```
[传送门：Koa封装](https://github.com/costaq/socketjs-koa)