npm.io
0.1.7 • Published 3 years ago

gejianwebsocket

Licence
MIT
Version
0.1.7
Deps
1
Size
9 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

SupWebsocket

基础介绍

本工具主要是以 ReactHooks 对 WebSocket 进行了一次封装，可以使用 Hooks 来使用 WebSocket。

安装

npm install @supcon/websocket

用法演示
import useWebsocket from '@supcon/websocket/src';

function a() {
  const {
    wsData,  //返回参数
    readyState,  //运行状态
    closeWebSocket,  //关闭连接
    webSocketInit,  //启动连接
    reconnect,  //重连
  } = useWebsocket({
    socketUrl: `/websocket/supWs`,  //socket连接
    isReload: true;  //是否自动重连，默认true
    isLog: true;  //是否显示日志，默认不显示
  });
}
API

Params

参数 说明 类型 默认值
socketUrl socket连接 string -
isReload 是否自动重连 boolean true
isLog 是否显示日志 boolean false

Result

参数 说明 类型 其他
wsData 返回参数 unknown -
readyState 运行状态 { key: number, value: string, message: error } { key: 0, value: '正在链接中' }
{ key: 1, value: '已经链接并且可以通讯' }
{ key: 2, value: '连接正在关闭' }
{ key: 3, value: '连接已关闭或者没有链接成功' }
closeWebSocket 关闭连接 () => void -
webSocketInit 启动连接 (url:string) => void 此处可以传入url，来覆盖初始化的url
reconnect 重连 () => void -