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

Interfaz: ExtendedRoutesConfig

Definido en: cli/src/api.ts:416

Config normalizado de la generación de la ruta devuelto por validateRoutesConfig.

Extensión

• RoutesConfig

Propiedades

authenticationModule?

optional authenticationModule?: string;

Definido en: packages/runtime/src/config.ts:274

Camino del módulo de autenticación utilizado por rutas generadas.

Inhered from

RoutesConfig.authenticationModule

---

basePath?

optional basePath?: string;

Definido en: packages/runtime/src/config.ts:254

Base API path; por ejemplo, el '/v1' en https://myapi.com/v1

Inhered from

RoutesConfig.basePath

---

bodyCoercion

bodyCoercion: boolean;

Definido en: cli/src/api.ts:419

Ya sea para coaccionar implícitamente los parámetros del cuerpo en un tipo aceptado.

Default

true

Anulaciones

RoutesConfig.bodyCoercion

---

controllerPathGlobs?

optional controllerPathGlobs?: string[];

Definido en: cli/src/api.ts:420

---

entryFile

entryFile: string;

Definido en: cli/src/api.ts:417

---

esm?

optional esm?: boolean;

Definido en: packages/runtime/src/config.ts:281

Cuando se activa, las importaciones generadas de rutas utilizan .js extensions for ESM output.

Default

false

Inhered from

RoutesConfig.esm

---

iocModule?

optional iocModule?: string;

Definido en: packages/runtime/src/config.ts:269

Carril del módulo IoC, por ejemplo ./inversify/ioc.

Inhered from

RoutesConfig.iocModule

---

middleware?

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

Definido en: packages/runtime/src/config.ts:259

Proveedor de Middleware.

Inhered from

RoutesConfig.middleware

---

middlewareTemplate?

optional middlewareTemplate?: string;

Definido en: packages/runtime/src/config.ts:264

Aduanas Handlebars Patrón de plantilla utilizado en lugar de la plantilla de middleware incorporado.

Inhered from

RoutesConfig.middlewareTemplate

---

multerOpts?

optional multerOpts?: Options;

Definido en: cli/src/api.ts:421

---

noImplicitAdditionalProperties

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

Definido en: cli/src/api.ts:418

---

noWriteIfUnchanged?

optional noWriteIfUnchanged?: boolean;

Definido en: packages/runtime/src/config.ts:249

Saltar escribiendo el archivo de ruta cuando el contenido generado coincide con el archivo existente.

Inhered from

RoutesConfig.noWriteIfUnchanged

---

rewriteRelativeImportExtensions?

optional rewriteRelativeImportExtensions?: boolean;

Definido en: packages/runtime/src/config.ts:295

Cuando se activa, las importaciones de rutas generadas se mantienen .ts prórrogas para apoyar TypeScript 5.7 rewriteRelativeImportExtensions.

Default

false

Inhered from

RoutesConfig.rewriteRelativeImportExtensions

---

rootSecurity?

optional rootSecurity?: Security[];

Definido en: cli/src/api.ts:422

---

routeGenerator?

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

Definido en: cli/src/api.ts:424

---

routesDir

routesDir: string;

Definido en: packages/runtime/src/config.ts:239

Directorio donde se escriben los archivos de ruta generados.

Inhered from

RoutesConfig.routesDir

---

routesFileName?

optional routesFileName?: string;

Definido en: packages/runtime/src/config.ts:244

Nombre de archivo para el módulo de ruta generado.

Inhered from

RoutesConfig.routesFileName

---

runtimeSpecConfig?

optional runtimeSpecConfig?: RuntimeSpecConfigSnapshot;

Definido en: cli/src/api.ts:423

Contributors

No contributors

Changelog

No recent changes