Skip to main content
This release is a pre-release — the latest non-prerelease version of @fedify/fedify is 1.2.3. Jump to this version

@fedify/fedify@1.3.0-dev.477+5c1eaa6b
Built and signed on GitHub Actions

An ActivityPub/fediverse server framework

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 Score
100%
Published
a week ago (1.3.0-dev.477+5c1eaa6b)
method Federation.setOutboxDispatcher
Federation.setOutboxDispatcher(
path: `${string}{identifier}${string}` | `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers an outbox dispatcher.

Examples

Example 1

federation.setOutboxDispatcher(
  "/users/{identifier}/outbox",
  async (ctx, identifier, options) => {
    let items: Activity[];
    let nextCursor: string;
    // ...
    return { items, nextCursor };
  }
);

Parameters

path: `${string}{identifier}${string}` | `${string}{handle}${string}`

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

dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>

An outbox dispatcher callback to register.

Return Type

CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Throws

@link RouterError

Thrown if the path pattern is invalid.

Add Package

deno add jsr:@fedify/fedify

Import symbol

import { type Federation } from "@fedify/fedify";

---- OR ----

Import directly with a jsr specifier

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

Add Package

npx jsr add @fedify/fedify

Import symbol

import { type Federation } from "@fedify/fedify";

Add Package

yarn dlx jsr add @fedify/fedify

Import symbol

import { type Federation } from "@fedify/fedify";

Add Package

pnpm dlx jsr add @fedify/fedify

Import symbol

import { type Federation } from "@fedify/fedify";

Add Package

bunx jsr add @fedify/fedify

Import symbol

import { type Federation } from "@fedify/fedify";