# IPC

# 安装

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

# 引入

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

# Constructor

  • Constructor Parameters

    • path : string 连接路径
    • timeout? : number 超时时间 (ms) Default: 60000
    • __namedParameters? : object
      • delimiter? : string : 分隔符 Default: \n
      • retryTimes? : number : 连接断开后,重试连接次数 Default 10
      • retryInterval? : number : 连接断开后,重试连接间隔 (ms) Default 10000
  • Example

import IPC_RPC from "@vite/vitejs-ipc";

const ipcProvider = new IPC_RPC("~/.gvite/testdata/gvite.ipc");

# Properties

Name Type Description
path string 连接路径
delimiter string 分隔符
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

取消订阅