darkws

中文文档
5.1.3发布于 2026/11/03MITTypeScriptES Module零依赖构建来源已验证

浏览器的无依赖的DarkWS客户端

中文使用文档
DarkWS logo

darkws

npm CI Types Docs License

的无依赖浏览器客户端 DarkWS 服务器:输入请求,广播订阅,带回退的重新连接,心跳, 选择加入重试,以及自动会话恢复。ESM与TypeScript声明。

npm install darkws
import DarkWs, { ErrorResponse } from "darkws";

const client = new DarkWs({
  secure: location.protocol === "https:",
  path: "/ws",
  authenticationToken: () => auth.accessToken(),
}).connect();

const user = await client.request<User>("user:get", { id: "42" });

const unsubscribe = client.onAction<User>("user:updated", updated => render(updated));

try {
  await client.request("user:delete", { id: "42" });
} catch (error) {
  if (error instanceof ErrorResponse) console.warn(error.message); // the server's error code
}

unsubscribe();
client.dispose();

有关首次使用时创建的应用程序范围的客户端,请参见 DarkWs.lazy()。

文档

版本与发布记录

darkws 共发布 23 个版本,首次发布于 2023/05/22;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.1.3latest2026/11/03今天
5.1.22026/11/021 天前
5.1.12026/10/304 天前
5.1.02026/10/304 天前
5.0.02026/10/011 个月前
4.0.02026/09/161 个月前

关于 darkws 的常见问题

darkws 是什么?

浏览器的无依赖的DarkWS客户端

如何安装 darkws?

在项目目录运行 npm install darkws,或使用 pnpm add / yarn add / bun add。

darkws 支持 TypeScript 吗?

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

darkws 支持 ESM 还是 CommonJS?

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

darkws 可以商用吗?

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

darkws 还在维护吗?

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