# @graffy/link 中文文档

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

版本：0\.19\.7
npm 元数据更新时间：2026-09-16T04:47:21.976Z
中文译文更新时间：2026-11-17T04:03:52.926Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：18.5 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-10-21T14:02:03.040Z
- 最新版本发布：2026-09-16T04:47:21.626Z
- 近 30 天下载量：6879（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：148（近 12 个月 21 个）

## 中文简介

使用直观的,宣示性的注解来构建链接的Graffy模块.

## 安装

```sh
npm install @graffy/link
```

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

## README

# Graffy 链接

使用直观的,宣示性的注解来构建链接的Graffy模块.

## 示例

考虑建立博客数据模型, 每个帖子都有一个 `authorId` 我们想要财产 `author` 员额(与 以及财产 `posts` 用户,链接到一系列员额 由该用户编写 .

使用下列方法完成这项工作:

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

const store = new Graffy();
store.use(link({
    'posts.$key.author': ['users', '$$posts.$key.authorId'],
    'users.$key.posts': ['posts', { $all: true, authorId: '$$users.$key.id' }]
}));

// Add downstream providers to the store
```

## 链接定义

链接模块必须以包含一组链接的对象初始化 定义.

-   每个链接定义包括两个路径,即: _来源_ 编辑 _目标_。 。 。 . 源路径必须是点分隔的字符串. 目标路径必须是 数组字符串或参数对象.
-   来源可能包含 _通配符_ 段从 `$` 接着是 一个任意的名称。 曾经的通卡 _定义_ 在源路径中可能 在目标路径中将其替换为匹配的密钥 查询.
-   目标可包括: _查询_ 字符串从 `$$` 接着是 点分隔的字符串路径(可能包括通配符). 这些都换了 ,下游提供者返回的值.

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

## 常见问题

### @graffy/link 是什么？

使用直观的,宣示性的注解来构建链接的Graffy模块\.

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

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

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

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

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

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

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

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

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

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

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

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

