Skip to main content

Browse packagesDocsSign in

This release is 5 versions behind 1.0.2 — the latest version of @fedify/fedify. Jump to latest

@fedify/fedify@0.15.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

An ActivityPub/fediverse server framework

This package works with Node.js

This package works with Deno

This package works with Bun

Published

a month ago (0.15.0)

@fedify/fedify

federation

Federation

interface Federation

An object that registers federation-related business logic and dispatches requests to the appropriate handlers.

It also provides a middleware interface for handling requests before your web framework's router; see Federation.fetch.

Type Parameters



TContextData

Methods



startQueue(contextData: TContextData): Promise<void>

Manually start the task queue.

This method is useful when you set the manuallyStartQueue option to true in the createFederation function.



createContext(baseUrl: URL,
contextData: TContextData,
): Context<TContextData>

Create a new context.



createContext(request: Request,
contextData: TContextData,
): RequestContext<TContextData>

Create a new context for a request.



setNodeInfoDispatcher(path: string,
dispatcher: NodeInfoDispatcher<TContextData>,
): void

Registers a NodeInfo dispatcher.



setActorDispatcher(path: `${string}{handle}${string}`,
dispatcher: ActorDispatcher<TContextData>,
): ActorCallbackSetters<TContextData>

Registers an actor dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}{${TParam}}${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setObjectDispatcher<TObject extends Object,
TParam extends string,
>(cls: (new (...args: any[]) => TObject) & { typeId: URL;  },
path: `${string}{${TParam}}${string}`,
dispatcher: ObjectDispatcher<TContextData, TObject, TParam>,
): ObjectCallbackSetters<TContextData, TObject, TParam>

Registers an object dispatcher.



setInboxDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers an inbox dispatcher.



setOutboxDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers an outbox dispatcher.



setFollowingDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Actor | URL, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers a following collection dispatcher.



setFollowersDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Recipient, Context<TContextData>, TContextData, URL>,
): CollectionCallbackSetters<Context<TContextData>, TContextData, URL>

Registers a followers collection dispatcher.



setLikedDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Object | URL, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers a liked collection dispatcher.



setFeaturedDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Object, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers a featured collection dispatcher.



setFeaturedTagsDispatcher(path: `${string}{handle}${string}`,
dispatcher: CollectionDispatcher<Hashtag, RequestContext<TContextData>, TContextData, void>,
): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>

Registers a featured tags collection dispatcher.



setInboxListeners(inboxPath: `${string}{handle}${string}`,
sharedInboxPath?: string,
): InboxListenerSetters<TContextData>

Assigns the URL path for the inbox and starts setting inbox listeners.



fetch(request: Request,
options: FederationFetchOptions<TContextData>,
): Promise<Response>

Handles a request related to federation. If a request is not related to federation, the onNotFound or onNotAcceptable callback is called.

Usually, this method is called from a server's request handler or a web framework's middleware.

Add Package

deno add jsr:@fedify/fedify

Import symbol

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

---- OR ----

Import directly with a jsr specifier

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

Add Package

npx jsr add @fedify/fedify

Import symbol

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

Add Package

yarn dlx jsr add @fedify/fedify

Import symbol

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

Add Package

pnpm dlx jsr add @fedify/fedify

Import symbol

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

Add Package

bunx jsr add @fedify/fedify

Import symbol

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