Loading cspell.json +3 −2 Original line number Diff line number Diff line Loading @@ -98,6 +98,7 @@ "vitepress", "vtsls", "webfinger", "webp" "webp", "Federatable" ] } No newline at end of file docs/manual/actor.md +1 −1 Original line number Diff line number Diff line Loading @@ -49,7 +49,7 @@ federation.setActorDispatcher("/users/{identifier}", async (ctx, identifier) => }); ~~~~ In the above example, the `~Federation.setActorDispatcher()` method registers In the above example, the `~Federatable.setActorDispatcher()` method registers an actor dispatcher for the `/users/{identifier}` path. This pattern syntax follows the [URI Template] specification. Loading docs/manual/collections.md +2 −2 Original line number Diff line number Diff line Loading @@ -29,7 +29,7 @@ First, let's see how to construct an [outbox] collection. An outbox collection consists of the activities that an actor has sent. As each collection has its own URI, the outbox collection has its own URI, too. The URI of the outbox collection is determined by the first parameter of the `Federation.setOutboxDispatcher()` method: the `~Federatable.setOutboxDispatcher()` method: ~~~~ typescript twoslash // @noErrors: 2345 Loading Loading @@ -162,7 +162,7 @@ If your database system supports only offset-based pagination (the most relational databases), you can use the offset as the cursor. Although it's omitted in the previous example, there is the third parameter to a callback that `~Federation.setOutboxDispatcher()` method takes: the cursor. a callback that `~Federatable.setOutboxDispatcher()` method takes: the cursor. When the request is for a collection page, the cursor is passed to the callback as the third parameter. When the request is for a whole collection, the cursor is `null` (that the previous example assumes). Loading docs/manual/inbox.md +1 −1 Original line number Diff line number Diff line Loading @@ -73,7 +73,7 @@ federation }); ~~~~ In the above example, the `~Federation.setInboxListeners()` method registers In the above example, the `~Federatable.setInboxListeners()` method registers path patterns for the personal inbox and the shared inbox, and the following `~InboxListenerSetters.on()` method registers an inbox listener for the `Follow` activity. The `~InboxListenerSetters.on()` method takes a class of the activity Loading docs/manual/nodeinfo.md +2 −2 Original line number Diff line number Diff line Loading @@ -33,8 +33,8 @@ Exposing NodeInfo endpoint -------------------------- To expose a NodeInfo endpoint, you need to register a NodeInfo dispatcher with `Federation.setNodeInfoDispatcher()` method. The following shows how to expose a NodeInfo endpoint: `~Federatable.setNodeInfoDispatcher()` method. The following shows how to expose a NodeInfo endpoint: ~~~~ typescript twoslash // @noErrors: 2345 Loading Loading
cspell.json +3 −2 Original line number Diff line number Diff line Loading @@ -98,6 +98,7 @@ "vitepress", "vtsls", "webfinger", "webp" "webp", "Federatable" ] } No newline at end of file
docs/manual/actor.md +1 −1 Original line number Diff line number Diff line Loading @@ -49,7 +49,7 @@ federation.setActorDispatcher("/users/{identifier}", async (ctx, identifier) => }); ~~~~ In the above example, the `~Federation.setActorDispatcher()` method registers In the above example, the `~Federatable.setActorDispatcher()` method registers an actor dispatcher for the `/users/{identifier}` path. This pattern syntax follows the [URI Template] specification. Loading
docs/manual/collections.md +2 −2 Original line number Diff line number Diff line Loading @@ -29,7 +29,7 @@ First, let's see how to construct an [outbox] collection. An outbox collection consists of the activities that an actor has sent. As each collection has its own URI, the outbox collection has its own URI, too. The URI of the outbox collection is determined by the first parameter of the `Federation.setOutboxDispatcher()` method: the `~Federatable.setOutboxDispatcher()` method: ~~~~ typescript twoslash // @noErrors: 2345 Loading Loading @@ -162,7 +162,7 @@ If your database system supports only offset-based pagination (the most relational databases), you can use the offset as the cursor. Although it's omitted in the previous example, there is the third parameter to a callback that `~Federation.setOutboxDispatcher()` method takes: the cursor. a callback that `~Federatable.setOutboxDispatcher()` method takes: the cursor. When the request is for a collection page, the cursor is passed to the callback as the third parameter. When the request is for a whole collection, the cursor is `null` (that the previous example assumes). Loading
docs/manual/inbox.md +1 −1 Original line number Diff line number Diff line Loading @@ -73,7 +73,7 @@ federation }); ~~~~ In the above example, the `~Federation.setInboxListeners()` method registers In the above example, the `~Federatable.setInboxListeners()` method registers path patterns for the personal inbox and the shared inbox, and the following `~InboxListenerSetters.on()` method registers an inbox listener for the `Follow` activity. The `~InboxListenerSetters.on()` method takes a class of the activity Loading
docs/manual/nodeinfo.md +2 −2 Original line number Diff line number Diff line Loading @@ -33,8 +33,8 @@ Exposing NodeInfo endpoint -------------------------- To expose a NodeInfo endpoint, you need to register a NodeInfo dispatcher with `Federation.setNodeInfoDispatcher()` method. The following shows how to expose a NodeInfo endpoint: `~Federatable.setNodeInfoDispatcher()` method. The following shows how to expose a NodeInfo endpoint: ~~~~ typescript twoslash // @noErrors: 2345 Loading