Optional
allowCustom value, which indicates, that, if empty settings are allowed or not.
Optional
authorizeOptions for 'authorize' feature.
Optional
importsList of (value) imports.
Optional
loadTries to load endpoint documentation from .openapi
files.
true
Optional
noDefault value, that indicates, that query parameters should NOT be parsed.
Optional
onAn optional function, that is invoked after a controller has been created, initialized and added to the context.
Optional
onAn optional function, that is invoked after a controller method has been created, initialized and added to the context.
Optional
onDefault parse error handler.
Optional
onDefault schema validation error handler.
Optional
onAn optional function, that is invoked after a Swagger documentation has been loaded, initialized and added to the context.
Optional
onThe default handler, that is executed, when object validation with Swagger documentation failed.
Optional
parameterThe custom URL parameter format.
@default: ControllerParameterFormat.Default
Optional
patternsThe custom file patterns.
Optional
requiresValue, which indicates, if all endpoints should have documentation or not.
true
Optional
requiresCustom value, which indicates, that, if no settings are specified, a module file with it is required.
Optional
requiresCustom value, which indicates, that all endpoints require at least one test.
Optional
rootThe custom root directory.
"controllers"
Optional
swaggerOptions to setup Swagger UI.
Optional
testCustom value for a (default) timeout for tests, in ms.
5000
Optional
validateDefault, which indicates, to validate request data with schema in documentation
prop
of a request decorator like @GET()
or @POST()
or not.
false
Generated using TypeDoc
Options for 'controllers()' method of 'IHttpServer' instance.