# @graffy/client 中文文档

规范地址：https://npmcn.com/package/%40graffy/client/

版本：0\.19\.7
npm 元数据更新时间：2026-09-16T04:46:19.753Z
中文译文更新时间：2026-11-17T03:30:56.258Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40graffy/client
原文对照：https://npmcn.com/package/%40graffy/client/?lang=original
项目主页：https://github.com/usegraffy/graffy#readme
源码仓库：https://github.com/usegraffy/graffy

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：14 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2019-03-15T16:09:08.710Z
- 最新版本发布：2026-09-16T04:46:19.337Z
- 近 30 天下载量：7461（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：255（近 12 个月 21 个）

## 中文简介

用于浏览器的 Graffy 客户端库 `fetch()` 或者说 `WebSocket` APIs (英语). 本模块意在与运行Graffy Server的Node.js服务器一起使用.

## 安装

```sh
npm install @graffy/client
```

也可以使用：`pnpm add @graffy/client`、`yarn add @graffy/client`、`bun add @graffy/client`

## README

# Graffy 客户端

用于浏览器的 Graffy 客户端库 `fetch()` 或者说 `WebSocket` APIs (英语). 本模块意在与运行Graffy Server的Node.js服务器一起使用.

## 使用量

```js
import Graffy from '@graffy/core';
import client from '@graffy/client';

const store = new Graffy();
store.use(client(url, options));

// Add downstream providers to the store
```

如果 URL 开始于 `http(s)://`,如果开始于 `ws(s)://`。 。 。 .

### 选项

-   `getOptions(operation, payload, options)`,以获取每个操作中应该传递给服务器的选项.
-   `connInfoPath`,在商店中放置连接元数据的位置。 默认为 `connection`。 。 。 .

### 连接状态

如果使用 WebSocket 连接, Graffy 客户端将创建 `connection: { status: boolean }` 店中节点. 此节点的位置可以由 `connInfoPath` 选项。 从此节点读取或观看此节点可提供当前连接状态的信息. 应用程序可以通过写入明确撕毁或重建连接 `false` 或者说 `true` 分别交给它.

见 [Graffy 文档](https://graffy.org/#/GraffyClient) 为了更多.

## 常见问题

### @graffy/client 是什么？

用于浏览器的 Graffy 客户端库 fetch\(\) 或者说 WebSocket APIs \(英语\)\. 本模块意在与运行Graffy Server的Node\.js服务器一起使用\.

### 如何安装 @graffy/client？

在项目目录运行 npm install @graffy/client，或使用 pnpm add / yarn add / bun add。

### @graffy/client 支持 TypeScript 吗？

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

### @graffy/client 支持 ESM 还是 CommonJS？

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

### @graffy/client 可以商用吗？

@graffy/client 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @graffy/client 的下载量有多少？

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

### @graffy/client 还在维护吗？

最新版本 0\.19\.7 发布于 2026/09/16（2 个月前）；至今共发布 255 个版本，其中过去 12 个月发布了 21 个；首次发布于 2019/03/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

