@handrail-chat/client

中文文档
0.4.0发布于 2026/10/17UNLICENSEDTypeScriptES Module零依赖近 30 天下载 8268

Handrail 的框架不可知客户端——运输,会话交换,和对话状态.

中文使用文档
文档目录5 节
  1. 它给你什么
  2. 运输接合
  3. 代理人的背景
  4. 页:1
  5. 许可证

@handrail-chat/客户端

框架不可知核心 手推车 - 一个应用 帮助表面显示客户在您的产品中求取帮助, 代理商回答 斯莱克.

如果您正在使用 React 构建, 请安装 @handrail-chat/react 换句话说. 它取决于这个包 并给你一个面板,一个发射器和 钩子. 这个是用来建立自己的UI, 或者一个约束另一个框架.

bun add @handrail-chat/client

没有运行时间依赖 .

它给你什么

import { createHandrail, createSseTransport } from "@handrail-chat/client";

const handrail = createHandrail({
  transport: createSseTransport({
    baseUrl: "https://api.handrail.chat",
    getToken: async () => (await fetch("/api/handrail-token")).json().then((r) => r.token),
  }),
});

handrail.subscribe(() => render(handrail.getState()));
await handrail.start();

await handrail.send("my export keeps failing");

getState() 返回信件、对话、连接状态和状态. subscribe 每变一变,就放火 这里没有州立图书馆,也没有 强迫你.

参见 React 包的 README 的令牌合同——你的后端需要的 和为什么.

运输接合

Transport 是两个执行的接口. SseTransport 与一个 真正的手推车; MockTransport 是内存,不需要服务器、数据库或 斯莱克 运输线上没有任何东西能把他们分辨出来,这就是我们 在测试和故事中可以从固定装置中驱动相同的组件.

import { createMockTransport } from "@handrail-chat/client";

const transport = createMockTransport();
const handrail = createHandrail({ transport });

transport.receiveAgentMessage("Looking into it now");

代理人的背景

有两种方式告诉Slack里的人 客户没有打字. 也没有向顾客展示过 React 软件包的 README 覆盖了两者 以一个完整的例子.

// An outcome the agent must not miss. Its own Slack message; works with the
// panel closed and on a resolved conversation.
await handrail.postNote('👍 "Exchanging tickets" solved it', { conversationId });

// What the customer is doing while they talk. Grey lines in one growing Slack
// message; sent only while the panel is open and the conversation unresolved.
handrail.setPanelOpen(true); // from your panel, as it opens and closes
handrail.trackActivity({ kind: "page", text: "Order #1234", url: location.href });

trackActivity 永不扔出并返回任何信息: 事件被分批处理 4分之1秒,失败的发送被放弃而不是重审.

页:1

实时更新使用 fetch 有溪流,没有 EventSource - 后者 无法设置信头, 从而将会话符号强制为查询字符串 在访问日志和浏览器历史中登陆.

start() 从不拒绝所以不用等就可以打电话了 如果 部件无法连接 - 您 getToken 扔出,否则网络会倒塌.. status 实值 "error" 财务报告和审定财务报表 error {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}说为什么 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}它用背面来重复 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}直到 它会的。 打开辅助发射器 status,而不是关于是否 start() 解决.

重新连接到三角洲而不是整个历史.

送信很乐观 由客户端生成的id调节,所以没有 当服务器的回声到达时重复 。 发送失败保留状态标记 failed 联合国 clientId,准备 retry。 。 。 .

许可证

尚未开放源代码.

版本与发布记录

@handrail-chat/client 共发布 5 个版本,首次发布于 2026/09/08;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.4.0latest2026/10/171 个月前
0.3.12026/10/061 个月前
0.3.02026/09/271 个月前
0.2.02026/09/271 个月前
0.1.02026/09/082 个月前

关于 @handrail-chat/client 的常见问题

@handrail-chat/client 是什么?

Handrail 的框架不可知客户端——运输,会话交换,和对话状态.

如何安装 @handrail-chat/client?

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

@handrail-chat/client 支持 TypeScript 吗?

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

@handrail-chat/client 支持 ESM 还是 CommonJS?

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

@handrail-chat/client 可以商用吗?

@handrail-chat/client 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@handrail-chat/client 的下载量有多少?

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

@handrail-chat/client 还在维护吗?

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