# @fedify/webfinger 中文文档

规范地址：https://npmcn.com/package/%40fedify/webfinger/

版本：2\.1\.32
npm 元数据更新时间：2026-11-17T06:45:45.427Z
中文译文更新时间：2026-11-17T06:04:17.658Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fedify/webfinger
原文对照：https://npmcn.com/package/%40fedify/webfinger/?lang=original
项目主页：https://fedify.dev/
源码仓库：https://github.com/fedify-dev/fedify

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

- 包体积（解压后）：250 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：4 个
- 首次发布：2026-01-12T13:29:44.876Z
- 最新版本发布：2026-11-17T06:45:45.043Z
- 近 30 天下载量：76896（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：546（近 12 个月 546 个）

## 中文简介

活动工具 WebFinger 客户端库

## 安装

```sh
npm install @fedify/webfinger
```

也可以使用：`pnpm add @fedify/webfinger`、`yarn add @fedify/webfinger`、`bun add @fedify/webfinger`

## README

# @fedify/webfingger:用于活动Pub的WebFinger客户端库

[![JSR](https://jsr.io/badges/@fedify/webfinger)](https://jsr.io/@fedify/webfinger) [![npm](https://img.shields.io/npm/v/@fedify/webfinger?logo=npm)](https://www.npmjs.com/package/@fedify/webfinger)

此软件包提供了WebFinger客户端执行,用于查询 活动Pub的行为者和联邦的其他资源。 这是其中的一部分 [联邦](https://fedify.dev/) 框架,但可以独立使用.

## 特征

-   WebFinger 资源查询([RFC 7033 (英语)](https://datatracker.ietf.org/doc/html/rfc7033)(中文(简体) )
-   支助 `acct:` URI 计划
-   自动 HTTPS URL 构建
-   可配置的定向处理
-   用于追踪的 OpenTeleometry 集成
-   安全的私人IP地址验证

## 安装

```bash
deno add jsr:@fedify/webfinger  # Deno
npm add @fedify/webfinger       # npm
pnpm add @fedify/webfinger      # pnpm
yarn add @fedify/webfinger      # Yarn
bun add @fedify/webfinger       # Bun
```

## 使用量

### 查找 WebFinger 资源

您可以使用 WebFinger 资源查找 `lookupWebFinger()` 函数 :

```typescript
import { lookupWebFinger } from "@fedify/webfinger";

// Look up by acct: URI
const result = await lookupWebFinger("acct:alice@example.com");

// Look up by URL
const result2 = await lookupWebFinger("https://example.com/users/alice");
```

### 与结果合作

结果是 `ResourceDescriptor` 包含主题、别名、, 属性和链接 :

```typescript
import { lookupWebFinger } from "@fedify/webfinger";

const result = await lookupWebFinger("acct:alice@example.com");
if (result != null) {
  console.log("Subject:", result.subject);
  console.log("Aliases:", result.aliases);

  // Find the ActivityPub actor URL
  const actorLink = result.links?.find(
    (link) => link.rel === "self" && link.type === "application/activity+json"
  );
  if (actorLink?.href != null) {
    console.log("Actor URL:", actorLink.href);
  }
}
```

### 配置选项

这个 `lookupWebFinger()` 函数接受各种选项:

```typescript
import { lookupWebFinger } from "@fedify/webfinger";

const result = await lookupWebFinger("acct:alice@example.com", {
  // Custom User-Agent header
  userAgent: "MyApp/1.0",

  // Maximum redirects to follow (default: 5)
  maxRedirection: 3,

  // Cancel sooner than the default 10-second lookup deadline
  signal: AbortSignal.timeout(5000),
});
```

每一次搜索都有10秒的最后期限,跨越DNS分辨率,重新定向,以及 反应读取。 提供的信号可以更快地结束,但不能扩展.

## API 密码

### 职能

-   `lookupWebFinger(resource, options?)`: 查找 WebFinger 资源并 返回 a `ResourceDescriptor` 或者说 `null` 如果找不到的话.

### 类型

-   `ResourceDescriptor`: 描述一个WebFinger资源,其中包含主题,别名, 属性和链接.
-   `Link`: 代表WebFinger回复中与关系类型、媒体的链接 类型、href、标题和属性.
-   `LookupWebFingerOptions`页:1 `lookupWebFinger()` 函数.

## 文档

综合文件请参见:

-   [WebFinger 文档](https://fedify.dev/manual/webfinger)
-   [API 参考](https://jsr.io/@fedify/webfinger/doc/~)

## 相关软件包

-   _@ feedify/feedify (帮助) @ info: whatsthis_:主要联邦框架
-   _@fedify/vocab (英语)_: 活动词汇库

## 许可证

[MIT 许可证](https://github.com/fedify-dev/fedify/blob/main/LICENSE)

## 常见问题

### @fedify/webfinger 是什么？

活动工具 WebFinger 客户端库

### 如何安装 @fedify/webfinger？

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

### @fedify/webfinger 支持 TypeScript 吗？

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

### @fedify/webfinger 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @fedify/webfinger 需要什么版本的 Node\.js？

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

### @fedify/webfinger 可以商用吗？

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

### @fedify/webfinger 的下载量有多少？

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

### @fedify/webfinger 还在维护吗？

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

