1.0.0 • Published 5 months ago
xl_ws v1.0.0
xl_ws
简单的 websocket 工具
继承事件 xl_events, 实现了心跳检查
自动重连:关闭重连、错误重连、心跳检查失败重连
构造函数
- new WS(url: string, option?: WsOption)
方法
- 监听 websocket open 事件:ws.on('open.openName',(data)=>{})
- 监听 websocket message 事件:ws.on('message.messageName',(data)=>{})
- 监听 websocket close 事件:ws.on('close.closeName',({code:number})=>{})
- 监听 websocket error 事件:ws.on('error.errorName',({code:number})=>{})
- ws.close(code:number,reason:string) code:默认1000
- ws.socket() 重连
- ws.send(message) 发送消息
属性(继承 websocket 属性)
- option: WsOption
- ws: WebSocket
- queues: []
demo
import WS from "xl_ws";
const client = new WS(url);
client.on("message.test", messageFn);
client.on("open.test", openFn);
client.on("close.test", closeFn);
client.on("error.test", errorFn);
client.send();
client.close();
类型
export interface WsOption {
protocols?: string | string[];
reConnectTime?: number;
/** ping 循环时间 */
pingTime?: number;
/** pong 超时时间 */
timeout?: number;
autoPing?: boolean;
/** ping 的数据 */
ping?: unknown;
/** pong 的数据 */
pong?: unknown;
formatData?: (event: MessageEvent) => MessageEvent;
}
1.0.0
5 months ago