@openknot-ts/knot-rest-fastify
v0.0.6-preview
Published
Serves OpenKnot REST routes on the Fastify host.
Readme
@openknot-ts/knot-rest-fastify
Serves @openknot-ts/knot-rest routes on the Fastify host. The router and the selected route sets join through its requirements.
Usage
import { fastifyHttp } from "@openknot-ts/fastify-server";
import { restFastify } from "@openknot-ts/knot-rest-fastify";
import { defineApplication } from "@openknot-ts/wire";
export const application = defineApplication({ modules: [behavior, flow, io, transport, fastifyHttp, restFastify] });API
| Export | Description |
| --- | --- |
| restFastify | Ready module: joins the host's fastifyPlugins collection. |
| fastifyRestPlugin({ requirements?, maxBodySize? }) | The same with a body limit from the application's own config, which replaces REST_MAX_BODY_SIZE. |
Behavior
- Registers one catch-all route in its own encapsulated scope, so routes of other plugins (tRPC, health) take precedence; the router answers 404 and 405 for the rest.
- That scope leaves the request stream unread: the router reads a body only for routes that take one, through
readJsonBody, withapplication/jsonandREST_MAX_BODY_SIZE. 413 and 415 close the connection. Fastify'sbodyLimitapplies to the other plugins only. - Responses go through Fastify's reply, so its hooks run.
- The request's signal aborts when the response closes early; a stopping host still answers what it admitted.
Custom configuration
const plugin = fastifyRestPlugin({
requirements: { settings },
maxBodySize: ({ settings }) => settings.API_BODY_LIMIT,
});
// modules: [..., fastifyHttp, providePlugs([plugin])] instead of restFastifyExample and tests
pnpm --filter @openknot-ts/knot-rest-fastify exampletest/fastify.test.ts runs on a real host: status codes, limits, a client disconnect that leaves no published or retained work, and a request admitted before stop that is still answered.
