Commit 7218ae91 authored by Kim, Hyeonseo's avatar Kim, Hyeonseo Committed by Hyeonseo Kim
Browse files

docs: update parameter description 



Co-authored-by: default avatarHong Minhee (洪 民憙) <hong@minhee.org>
parent 386d23a3

docs/manual/webfinger.md

+5 −2
Original line number Diff line number Diff line
@@ -159,8 +159,11 @@ federation.setWebFingerLinksDispatcher(async (ctx, _resource) => { 


The WebFinger links dispatcher receives two parameters:



- `ctx`: The federation context

- `resource`: The resource The URL that provide additional info to dispatcher

`ctx`

:   The federation context



`resource`

:   The URL queried via WebFinger



> [!TIP]

> The WebFinger endpoint is automatically exposed at `/.well-known/webfinger`

packages/fedify/src/federation/callback.ts

+2 −1
Original line number Diff line number Diff line
@@ -20,7 +20,8 @@ export type NodeInfoDispatcher<TContextData> = ( 
 * A callback that dispatches a array of {@link Link}.

 *

 * @template TContextData The context data to pass to the {@link Context}.

 * @param resource The URL that provide additional info to dispatcher

 * @param resource The URL queried via WebFinger.

 * @returns Links related to the queried resource. 

 */

export type WebFingerLinksDispatcher<TContextData> = (

  context: RequestContext<TContextData>,