liwi-resources-websocket-client-node

中文文档
15.2.0发布于 2026/11/04ISCTypeScriptES Module构建来源已验证

节点websocket客户端实现liwi

中文使用文档
文档目录5 节
  1. 关于
  2. 安装
  3. 用法
  4. 选项
  5. 过期的令牌

liwi-resources-websocket-client-node

节点websocket客户端实现liwi

npm version npm downloads node version types

关于

节点 TransportClient,用来反对 liwi-resources-websocket-server。它是 liwi-resources-websocket-client 为节点主机连接:

  • 连接通过 ws 而不是node的全局 WebSocket,它不能设置握手头,
  • 所以 验证标题 可以在升级请求上发送,
  • 并且禁用了页面可见性感知,因此重新连接永远不会等待 visibilitychange 这不会发生。

安装

npm install --save liwi-resources-websocket-client-node

用法

import { createNodeWebsocketTransportClient } from "liwi-resources-websocket-client-node";

const transportClient = createNodeWebsocketTransportClient({
  url: "ws://localhost:4005/ws",
  headers: () => ({ authorization: `Bearer ${getToken()}` }),
  onConnectionFailure: (failure) => {
    if (failure.type === "handshake" && failure.status === 401) promptSignIn();
  },
});
transportClient.connect();

const tasksService = createTasksServiceClient(transportClient);

选项

一切 WebsocketTransportClientOptions 接受,除了 thirdWebsocketArgument, getThirdWebsocketArgument 和 visibilitySource,该包自己设置。加:

选项默认的描述
url(需要)Websocket端点。没有 location 来推导它
headers- - - - - -握手头,或返回它们的函数
webSocketOptions- - - - - -额外的 ws 客户的选择
webSocketImplementationwsWebSocket 要使用的构造函数

通过 headers 作为一个 函数 当令牌可以过期时:它在每次连接尝试时进行评估,因此重新连接携带刷新的令牌,而不是在创建时捕获的令牌。

webSocketOptions.headers 在下面合并 headers,所以 headers 在键碰撞中获胜。

过期的令牌

被拒绝的升级将通过 onConnectionFailure 使用HTTP状态,并且4xx停止重新连接循环,而不是永远重试。看到 连接失败。

版本与发布记录

liwi-resources-websocket-client-node 共发布 9 个版本,首次发布于 2026/09/13;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
15.2.0latest2026/11/041 天前
15.1.02026/11/022 天前
15.0.22026/11/022 天前
15.0.02026/10/1818 天前
14.0.02026/10/1124 天前
13.4.02026/10/0729 天前

关于 liwi-resources-websocket-client-node 的常见问题

liwi-resources-websocket-client-node 是什么?

节点websocket客户端实现liwi

如何安装 liwi-resources-websocket-client-node?

在项目目录运行 npm install liwi-resources-websocket-client-node,或使用 pnpm add / yarn add / bun add。

liwi-resources-websocket-client-node 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

liwi-resources-websocket-client-node 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

liwi-resources-websocket-client-node 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

liwi-resources-websocket-client-node 可以商用吗?

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

liwi-resources-websocket-client-node 还在维护吗?

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