Skip to content

Components

Self-contained feature modules you register with this.component(SomeComponent).

Built-in components

ComponentWhat it doesWhen you reach for it
AuthenticationJWT and Basic auth - token generation, protected routes, multi-strategyA route needs to know who the caller is
Authorization ExperimentalEnforcer-based RBAC/ABAC, voters, Casbin integrationA route needs a permission check beyond authentication
Health Check/health endpoint, ping/pongA load balancer or Kubernetes needs a liveness probe
MailEmail sending - multiple transports, templating, queue-basedThe app sends transactional or templated email
Request TrackerRequest ID, timing, structured request loggingAlways on - registered automatically, nothing to configure
Socket.IOReal-time over Socket.IO - Redis adapter, event-basedClients need rooms or Socket.IO-specific features
WebSocketNative Bun WebSocket, Redis pub/sub, heartbeatClients need a raw WebSocket without Socket.IO
Static AssetUpload/download files - MinIO, Bun S3, local diskThe app stores or serves user-uploaded files
API ReferenceOpenAPI generation, Scalar UI by default, Swagger UI optionalYou want a browsable UI for your REST routes
gRPCConnectRPC transport, unary RPC, decorator-basedThe app serves gRPC alongside or instead of REST

See also