@bufferapp/micro-rpc-client

中文文档
1.5.0发布于 2024/09/23MITCommonJS近 30 天下载 4.8万

通用的JS客户端,用于微转

中文使用文档
文档目录11 节
  1. 快速启动
  2. 使用量
  3. API 密码
  4. 构造器
  5. 列表 方法
  6. 调用
  7. 处理错误
  8. 成绩
  9. 失败( 手持)
  10. 失败( 未处理)
  11. 失败( 意外)

已贬值

从2024年9月23日起, micro-rpc-client 将无法维持 并堕落.

微端端端客户端

Build Status

通用JS RPC客户端 https://github.com/bufferapp/buffer-rpc/ 页面存档备份,存于互联网档案馆

快速启动

创建 RPC 客户端并调用添加函数

const RPCClient = require('micro-rpc-client');

const client = new RPCClient({
  url: 'https://localhost:3000/rpc',
});

const main = async () => {
  const result = await client.call('add', [1, 2]);
  console.log(result); // 3
};
main();

使用量

如何调用客户端方法的几个实例

const RPCClient = require('micro-rpc-client');

const client = new RPCClient({
  url: 'https://localhost:3000/rpc',
  sendCredentials: 'same-origin', // send cookies on same origin requests
});

const main = async () => {
  const methods = await client.listMethods();
  console.log(method);
  /*
  [
    {
      "docs": "add two numbers"
      "name": "add"
    },
    {
      "docs": "list all available methods",
      "name": "methods"
    }
  ]
  */
  const result = await client.call('add', [1, 2]);
  console.log(result); // 3
};
main();

API 密码

构造器

创建 RPC 客户端实例

const client = new RPCClient({
  url,
  sendCredentials,
});

url 密码 - 说吧 字符串 - RPC 端点服务器的完整url
发送证书 - 说吧 字符串 - 当发送像饼干一样的东西 与请求, 传递参数到证书 init 参数 在抓取 API https://developer.mozila.org/en-US/docs/Web/API/WindowOrWorker GlobalScope/fetch#Paramels (英语)

返回 RPC 客户端实例

列表 方法

在服务器上列出所有远程方法

const methods = await client.listMethods()

返回以远程方法列表解析的许诺

调用

const result = await client.call(name, args)

名称 - 说吧 字符串 - 远程 RPC 端点名称
参数 - 说吧 数组 或者说 对象 - 传递到远程 RPC 端点的参数

返回一个承诺,以结果解决,以错误拒绝.

处理错误

当调用远程函数时 call 答复有不同类别:

成绩

这是典型的成功案例

statusCode = 200
result = {} // JSON

失败( 手持)

从 创建错误数字 :

statusCode = 400
result = {
  error: 'string',
  code: 1000, // or some custom code
  handled: true,
}

失败( 未处理)

从 中间软件出错数字 :

statusCode = 500
result = {
  error: 'string',
  code: 1000, // or some custom code
  handled: true,
}

失败( 意外)

如果 中间软件出错 尚未连接, 或者发生了出乎意料的事情 .

版本与发布记录

@bufferapp/micro-rpc-client 共发布 9 个版本,首次发布于 2020/03/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.0latest2024/09/232 年前
1.4.32021/04/305 年前
1.4.2lastest2021/04/305 年前
1.4.1beta2021/04/305 年前
1.4.02021/04/305 年前
1.3.02021/04/305 年前

关于 @bufferapp/micro-rpc-client 的常见问题

@bufferapp/micro-rpc-client 是什么?

通用的JS客户端,用于微转

如何安装 @bufferapp/micro-rpc-client?

在项目目录运行 npm install @bufferapp/micro-rpc-client,或使用 pnpm add / yarn add / bun add。

@bufferapp/micro-rpc-client 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/bufferapp__micro-rpc-client 是否存在。

@bufferapp/micro-rpc-client 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@bufferapp/micro-rpc-client 可以商用吗?

@bufferapp/micro-rpc-client 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@bufferapp/micro-rpc-client 的下载量有多少?

根据 npm 官方下载统计,@bufferapp/micro-rpc-client 在 2026/10/09 – 2026/11/07 这 30 天内被下载 47,946 次,日均约 1,598 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bufferapp/micro-rpc-client 还在维护吗?

最新版本 1.5.0 发布于 2024/09/23(2 年前);至今共发布 9 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/03/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。