# Websocket

# 安装

npm install @vite/vitejs-ws --save
yarn add @vite/vitejs-ws

# 引入

import WS_RPC from "@vite/vitejs-ws";
const { WS_RPC } = require('@vite/vitejs-ws');

# Constructor

  • Constructor Parameters:

    • url : string 连接 url Default 'ws://localhost:31420'
    • timeout? : number 超时时间 (ms) Default: 60000
    • __namedParameters? : object
  • Example:

import WS_RPC from "@vite/vitejs-ws";
const wsProvider = new WS_RPC("ws://localhost:8080");

# Properties

除却通用实例方法与属性外

名称 类型 说明
url string 网络连接路径
protocol string 协议
headers object 请求头信息
clientConfig object 同上 (opens new window)
type string 网络传输协议类型
timeout number(ms) 请求超时时间

# Methods

# abort

打断当前连接的剩余请求,并将请求列表清空

# request

发起 request 请求

  • Parameters:

    • methodName : string 方法名
    • params : any 请求参数
  • Returns:

    • Promise< JsonRPC response >

# sendNotification

  • Parameters:
    • methodName : string 方法名
    • params : any 请求参数

# batch

  • Parameters:

    • requests : array<object>
      • type : string<request | notification | batch> : 请求类型
      • methodName : string : 方法名
      • params : any : 请求参数
  • Returns:

    • Promise< JsonRPC response >

# reconnect

网络重连

# disconnect

断开连接

# subscribe

订阅服务端推送事件

  • Parameters:
    • callback : Function 当有服务端推送事件时,则返回数据到此事件中

# unsubscribe

取消订阅