Interface RoutesConfig

Hierarchy

Properties

authenticationModule?: string

Authentication Module for express, hapi and koa

basePath?: string

Base API path; e.g. the '/v1' in https://myapi.com/v1

esm?: boolean

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

Default

false

iocModule?: string

IOC module; e.g. './inversify/ioc' where IOC container named iocContainer is defined (https://github.com/inversify/InversifyJS)

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

Middleware provider.

middlewareTemplate?: string

Override the Middleware template

noWriteIfUnchanged?: boolean

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

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