Skip to content

API Summary ​

ExportTypeSync?Description
defineConfig()functionsyncRegisters app config: port, prefix, env vars, environment endpoints, structured logger
defineController()functionsyncGeneric factory — returns ControllerFactory<TService>
defineModule()functionsyncDeclares a module with routes.
configsingleton—Access resolved config: config.port, config.env.X, config.endpoints.X, config.logger
appsingleton—Server singleton: app.listen(), app.shutdown(), app.useMiddleware()
loggersingleton—Free-form logger (logger.info(), logger.child('Context')) + typed events (logger.events.system(), .request(), .response(), .error(), .audit(), .security())
EventType, SecurityEvents, SystemEvent, AuditEvents, AuthOutcome, EventSeverityenums—Discriminators for typed structured logs
THROTTLE_CONFIGconstant—Rate limit presets: SECURITY, STRICT, STANDARD, PERMISSIVE, EXTRA_PERMISSIVE
*Exceptionclasses—14 HTTP exception classes (400–504). Throw anywhere, caught by framework

Lifecycle: defineConfig() → defineController() → defineModule() → app.listen()