tsoa-next / @tsoa-next/cli / ExtendedRoutesConfig

Interface: ExtendedRoutesConfig

Defined in: cli/src/api.ts:419

Normalized route-generation config returned by validateRoutesConfig.

Extends

• RoutesConfig

Properties

authenticationModule?

optional authenticationModule?: string;

Defined in: packages/runtime/src/config.ts:275

Authentication module path used by generated routes.

Inherited from

RoutesConfig.authenticationModule

---

basePath?

optional basePath?: string;

Defined in: packages/runtime/src/config.ts:255

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

Inherited from

RoutesConfig.basePath

---

bodyCoercion

bodyCoercion: boolean;

Defined in: cli/src/api.ts:422

Whether to implicitly coerce body parameters into an accepted type.

Default

true

Overrides

RoutesConfig.bodyCoercion

---

controllerPathGlobs?

optional controllerPathGlobs?: string[];

Defined in: cli/src/api.ts:423

---

entryFile

entryFile: string;

Defined in: cli/src/api.ts:420

---

esm?

optional esm?: boolean;

Defined in: packages/runtime/src/config.ts:282

When enabled, generated route imports use .js extensions for ESM output.

Default

false

Inherited from

RoutesConfig.esm

---

iocModule?

optional iocModule?: string;

Defined in: packages/runtime/src/config.ts:270

IoC module path, for example ./inversify/ioc.

Inherited from

RoutesConfig.iocModule

---

middleware?

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

Defined in: packages/runtime/src/config.ts:260

Middleware provider.

Inherited from

RoutesConfig.middleware

---

middlewareTemplate?

optional middlewareTemplate?: string;

Defined in: packages/runtime/src/config.ts:265

Custom Handlebars template path used instead of the built-in middleware template.

Inherited from

RoutesConfig.middlewareTemplate

---

multerOpts?

optional multerOpts?: Options;

Defined in: cli/src/api.ts:424

---

noImplicitAdditionalProperties

noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";

Defined in: cli/src/api.ts:421

---

noWriteIfUnchanged?

optional noWriteIfUnchanged?: boolean;

Defined in: packages/runtime/src/config.ts:250

Skips writing the route file when the generated content matches the existing file.

Inherited from

RoutesConfig.noWriteIfUnchanged

---

rewriteRelativeImportExtensions?

optional rewriteRelativeImportExtensions?: boolean;

Defined in: packages/runtime/src/config.ts:296

When enabled, generated route imports keep .ts extensions to support TypeScript 5.7 rewriteRelativeImportExtensions.

Default

false

Inherited from

RoutesConfig.rewriteRelativeImportExtensions

---

rootSecurity?

optional rootSecurity?: Security[];

Defined in: cli/src/api.ts:425

---

routeGenerator?

optional routeGenerator?: 
  | string
  | ((metadata, options) => AbstractRouteGenerator<ExtendedRoutesConfig>);

Defined in: cli/src/api.ts:427

---

routesDir

routesDir: string;

Defined in: packages/runtime/src/config.ts:240

Directory where generated route files are written.

Inherited from

RoutesConfig.routesDir

---

routesFileName?

optional routesFileName?: string;

Defined in: packages/runtime/src/config.ts:245

Filename for the generated route module.

Inherited from

RoutesConfig.routesFileName

---

runtimeSpecConfig?

optional runtimeSpecConfig?: RuntimeSpecConfigSnapshot;

Defined in: cli/src/api.ts:426