close
Skip to main content
Home
Browse packagesDocs
ImageSign In with GitHubImageSign In with GitLab

@fedify/webfinger@2.2.1
Built and signed on GitHub Actions

latest
fedify-dev/fedify
Works with
This package works with Cloudflare Workers, Node.js, Deno, BunIt is unknown whether this package works with Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
It is unknown whether this package works with Browsers
•JSR Score100%•
License
MIT
•
Downloads88/wk
•
Published5 days ago (2.2.1)

WebFinger client library for ActivityPub

Functions

f
lookupWebFinger(
resource: URL | string,
options?: LookupWebFingerOptions
): Promise<ResourceDescriptor | null>

Looks up a WebFinger resource.

Interfaces

I
Link

Represents a link. See also RFC 7033 section 4.4.4.

  • href: string

    A URI pointing to the target resource.

  • properties: Readonly<Record<string, string>>

    Conveys additional information about the link relation.

  • rel: string

    The link's relation type, which is either a URI or a registered relation type (see RFC 5988).

  • template: string

    A URI Template (RFC 6570) that can be used to construct URIs by substituting variables. Used primarily for subscription endpoints where parameters like account URIs need to be dynamically inserted.

  • titles: Readonly<Record<string, string>>

    Human-readable titles describing the link relation. If the language is unknown or unspecified, the key is "und".

  • type: string

    The media type of the target resource (see RFC 6838).

I
LookupWebFingerOptions

Options for lookupWebFinger.

  • allowPrivateAddress: boolean

    Whether to allow private IP addresses in the URL.

  • maxRedirection: number

    The maximum number of redirections to follow.

  • signal: AbortSignal

    AbortSignal for cancelling the request.

  • tracerProvider: TracerProvider

    The OpenTelemetry tracer provider. If omitted, the global tracer provider is used.

  • userAgent: GetUserAgentOptions | string

    The options for making User-Agent header. If a string is given, it is used as the User-Agent header value. If an object is given, it is passed to getUserAgent to generate the User-Agent header value.

I
ResourceDescriptor

Describes a resource. See also RFC 7033 section 4.4.

  • aliases: readonly string[]

    URIs that identify the same entity as the subject.

  • links: readonly Link[]

    Links to other resources.

  • properties: Readonly<Record<string, string>>

    Conveys additional information about the subject of this descriptor.

  • subject: string

    A URI that identifies the entity that this descriptor describes.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@fedify/webfinger

Import symbol

import * as mod from "@fedify/webfinger";
or

Import directly with a jsr specifier

import * as mod from "jsr:@fedify/webfinger";