web-socket-connect
TypeScript icon, indicating that this package has built-in type declarations

1.0.3-beta.1 • Public • Published

web-socket-connect 前端socket插件

前端socket插件,提供socket心跳检测、失败重连、手动关闭、发送数据、接受数据等功能

说明

1、插件入参说明:

入参 类型 是否必传 说明
vueType string 必传 告诉插件是vue2 还是vue3。 只能传vue2 或者vue3
reconnectTimeout number 非必传 重新连接进入延迟时间 默认5s
receiveMessageTimeout number 非必传 接收消息超时时间 默认10s
reconnectTimes number 非必传 重新进入次数 默认3次
heartBeat boolean 非必传 是否发送心跳包 默认true
reconnectInterval number 非必传 重新连接间隔
reconnectDelay number 非必传 重新进入延迟时间
reconnect boolean 非必传 是否定时重进入

发送给后端心跳包字段为:hearbeat

举例

const app = createApp(App);
app.use(webSocketConnect, {
  vueType: "vue3",
  heartBeat: false
});
app.mount("#app");

方法

插件注册后会往vue实例上挂在一个$ws的实例

  • 1、创建:createWebSocket(wsUrl: string)
  • 2、关闭连接:closeWebSocket()
  • 3、发送数据:sendSock(agentData: any, callback: Function, key: string)
  • 4、获取回调函数: setSockFn(key: string, callback: Function)
  • 5、重新连接socket方法:reConnectWebSocket()

Package Sidebar

Install

npm i web-socket-connect

Weekly Downloads

0

Version

1.0.3-beta.1

License

ISC

Unpacked Size

162 kB

Total Files

14

Last publish

Collaborators

  • hokageyeah