@chanx-js/client

中文文档
2.4.0发布于 2026/11/03MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 1993

Chanx AsyncAPI schemas的Type-seafe WebSocket客户端,具有专题多功能. 反应,Vue,Svelte和Solid绑定.

中文使用文档

@ chanx-js/客户端

用于JavaScript和TypeScript的WebSocket安全客户端. 从服务器的 AsyncAPI 计划生成它, 你所发送和接收的每封信件,都会输入:在浏览器、反应器、Vue、Svelte中, 固体,或者另一个节点服务. 没有运行时间依赖 .

文档 • 妇女 开始 • 妇女 为什么? • 妇女 API 密码

npm install @chanx-js/client
npm install -D @chanx-js/codegen
npx chanx-codegen http://localhost:8000/asyncapi.json   # writes src/generated
import { createClient } from '@chanx-js/client';

import { chat } from './src/generated/index.js';

const client = createClient({ baseUrl: 'ws://localhost:8000' });
const connection = client.connect(chat, { params: { room: 'lobby' } });

connection.on('notice', (message) => console.log(message.payload.text));
const pong = await connection.request({ action: 'ping' }); // typed: PongMessage
connection.send({ action: 'chat', payload: { text: 'hello' } });
  • 双向输入 : 错误的字段动作或字段是一个编译错误,以及 request() 同意答复,并宣布其行动.
  • 专题: 许多订阅通过一个套接字,在重新连接后恢复.
  • 重接和心跳 在组件之间安全共享套接字.
  • 在任何chanx服务器上工作, 节点 或者说 蟒。 。 。 .
导入对于
@chanx-js/client运行时间: 客户端、 连接、 话题
@chanx-js/client/reactuseChannel, (中文(简体) ), useTopic, (中文(简体) ), useTopics
@chanx-js/client/vue返回的可编译器
@chanx-js/client/svelte斯维尔特4号和5号仓库
@chanx-js/client/solid信号和接入器

麻省理工学院有执照.

版本与发布记录

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

版本发布日期距今
2.4.0latest2026/11/036 天前
2.3.22026/10/2713 天前
2.3.12026/10/2614 天前
2.3.02026/10/2515 天前
2.2.12026/10/2516 天前
2.2.02026/10/2416 天前

关于 @chanx-js/client 的常见问题

@chanx-js/client 是什么?

Chanx AsyncAPI schemas的Type-seafe WebSocket客户端,具有专题多功能. 反应,Vue,Svelte和Solid绑定.

如何安装 @chanx-js/client?

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

@chanx-js/client 支持 TypeScript 吗?

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

@chanx-js/client 支持 ESM 还是 CommonJS?

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

@chanx-js/client 需要什么版本的 Node.js?

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

@chanx-js/client 可以商用吗?

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

@chanx-js/client 的下载量有多少?

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

@chanx-js/client 还在维护吗?

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