@fedify/webfingger:用于活动Pub的WebFinger客户端库
此软件包提供了WebFinger客户端执行,用于查询 活动Pub的行为者和联邦的其他资源。 这是其中的一部分 联邦 框架,但可以独立使用.
特征
- WebFinger 资源查询(RFC 7033 (英语)(中文(简体) )
- 支助
acct:URI 计划 - 自动 HTTPS URL 构建
- 可配置的定向处理
- 用于追踪的 OpenTeleometry 集成
- 安全的私人IP地址验证
安装
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() 函数 :
import { lookupWebFinger } from "@fedify/webfinger";
// Look up by acct: URI
const result = await lookupWebFinger("acct:[email protected]");
// Look up by URL
const result2 = await lookupWebFinger("https://example.com/users/alice");
与结果合作
结果是 ResourceDescriptor 包含主题、别名、,
属性和链接 :
import { lookupWebFinger } from "@fedify/webfinger";
const result = await lookupWebFinger("acct:[email protected]");
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() 函数接受各种选项:
import { lookupWebFinger } from "@fedify/webfinger";
const result = await lookupWebFinger("acct:[email protected]", {
// 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 资源并 返回 aResourceDescriptor或者说null如果找不到的话.
类型
ResourceDescriptor: 描述一个WebFinger资源,其中包含主题,别名, 属性和链接.Link: 代表WebFinger回复中与关系类型、媒体的链接 类型、href、标题和属性.LookupWebFingerOptions页:1lookupWebFinger()函数.
文档
综合文件请参见:
相关软件包
- @ feedify/feedify (帮助) @ info: whatsthis:主要联邦框架
- @fedify/vocab (英语): 活动词汇库