Interface ExtendedRoutesConfig

interface ExtendedRoutesConfig {
    authenticationModule?: string;
    basePath?: string;
    bodyCoercion: boolean;
    controllerPathGlobs?: string[];
    entryFile: string;
    esm?: boolean;
    iocModule?: string;
    middleware?: "express" | "hapi" | "koa";
    middlewareTemplate?: string;
    multerOpts?: Options;
    noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
    noWriteIfUnchanged?: boolean;
    rootSecurity?: Swagger.Security[];
    routeGenerator?: string | RouteGeneratorImpl;
    routesDir: string;
    routesFileName?: string;

Hierarchy (view full)


authenticationModule?: string

Authentication Module for express, hapi and koa

basePath?: string

Base API path; e.g. the '/v1' in

bodyCoercion: boolean
controllerPathGlobs?: string[]
entryFile: string
esm?: boolean

When enabled, the imports in the routes files will have a .js extention to support esm.


iocModule?: string

IOC module; e.g. './inversify/ioc' where IOC container named iocContainer is defined (

middleware?: "express" | "hapi" | "koa"

Middleware provider.

middlewareTemplate?: string

Override the Middleware template

multerOpts?: Options
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras"
noWriteIfUnchanged?: boolean

Avoid writing the generated route file if the existing file is identical (useful to optimize watch processes); false by default

rootSecurity?: Swagger.Security[]
routeGenerator?: string | RouteGeneratorImpl
routesDir: string

Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here

routesFileName?: string

Routes filename; the filename of the generated route file ('routes.ts' by default)

Generated using TypeDoc