Skip to main content
This release is versions behind 2.1.10 — the latest version of @fedify/fedify.

Built and signed on GitHub Actions

Works with
This package works with Node.js, Deno, Bun
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score88%
License
MIT
Downloads6,099/wk
Published4 weeks ago (2.1.2)

An ActivityPub/fediverse server framework

method Federatable.setActorDispatcher
Federatable.setActorDispatcher(
path: `${string}${Rfc6570Expression<"identifier">}${string}`,
dispatcher: ActorDispatcher<TContextData>
): ActorCallbackSetters<TContextData>

Registers an actor dispatcher.

Examples

Example 1

federation.setActorDispatcher(
  "/users/{identifier}",
  async (ctx, identifier) => {
    return new Person({
      id: ctx.getActorUri(identifier),
      // ...
    });
  }
);

Parameters

path: `${string}${Rfc6570Expression<"identifier">}${string}`

The URI path pattern for the actor dispatcher. The syntax is based on URI Template (RFC 6570). The path must have one variable: {identifier}.

dispatcher: ActorDispatcher<TContextData>

An actor dispatcher callback to register.

Return Type

An object with methods to set other actor dispatcher callbacks.

Throws

RouterError

Thrown if the path pattern is invalid.

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/fedify

Import symbol

import { type Federatable } from "@fedify/fedify";
or

Import directly with a jsr specifier

import { type Federatable } from "jsr:@fedify/fedify";