tsoa-next / @tsoa-next/cli / AbstractRouteGenerator

Clase abstracta: AbstractRouteGenerator<Config>

Definido en: cli/src/routeGeneration/routeGenerator.ts:11

Aplicación de bases para generadores de rutas que transforman metadatos en archivos de ruta específicos para marcos.

Extendido por

• DefaultRouteGenerator

Parámetros tipo

Config

Config Existe ExtendedRoutesConfig

Constructores

Constructor

new AbstractRouteGenerator<Config>(metadata, options): AbstractRouteGenerator<Config>;

Definido en: cli/src/routeGeneration/routeGenerator.ts:12

Parámetros

metadata

Metadata

options

Config

Devoluciones

AbstractRouteGenerator<Config>

Propiedades

metadata

protected readonly metadata: Metadata;

Definido en: cli/src/routeGeneration/routeGenerator.ts:13

---

options

protected readonly options: Config;

Definido en: cli/src/routeGeneration/routeGenerator.ts:14

Métodos

buildContext()

protected buildContext(): object;

Definido en: cli/src/routeGeneration/routeGenerator.ts:76

Construye los Handlebars contexto de plantilla utilizado por las plantillas de ruta predeterminadas.

Devoluciones

object

authenticationModule

authenticationModule: string | undefined;

basePath

basePath: string = normalisedBasePath;

canImportByAlias

canImportByAlias: boolean;

controllers

controllers: object[];

embeddedSpecGeneratorArtifacts

embeddedSpecGeneratorArtifacts: 
  | {
  spec: Spec;
  yaml: string;
}
  | undefined;

environment

environment: ProcessEnv = process.env;

esm

esm: boolean | undefined;

existingGetPaths

existingGetPaths: string[];

iocModule

iocModule: string | undefined;

minimalSwaggerConfig

minimalSwaggerConfig: object;

minimalSwaggerConfig.bodyCoercion

bodyCoercion: boolean;

minimalSwaggerConfig.noImplicit

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

models

models: Models;

multerOpts

multerOpts: Config["multerOpts"];

runtimeSpecConfig

runtimeSpecConfig: 
  | {
  compilerOptions?: Record<string, unknown>;
  defaultNumberType?: "double" | "float" | "integer" | "long";
  ignore?: string[];
  metadata: Metadata;
  spec: SpecConfig & object;
}
  | undefined;

useFileUploads

useFileUploads: boolean;

useSecurity

useSecurity: boolean;

useSpecPaths

useSpecPaths: boolean;

---

buildEmbeddedSpecGeneratorArtifacts()

protected buildEmbeddedSpecGeneratorArtifacts(useSpecPaths): 
  | {
  spec: Spec;
  yaml: string;
}
  | undefined;

Definido en: cli/src/routeGeneration/routeGenerator.ts:157

Parámetros

useSpecPaths

boolean

Devoluciones

| { spec: Spec; yaml: string; } | undefined

---

buildModels()

buildModels(): Models;

Definido en: cli/src/routeGeneration/routeGenerator.ts:23

Construye los metadatos modelo de tiempo de ejecución consumidos por los manipuladores de rutas generados.

Devoluciones

Models

---

buildParameterSchema()

protected buildParameterSchema(source): ParameterSchema;

Definido en: cli/src/routeGeneration/routeGenerator.ts:199

Parámetros

source

Parameter

Devoluciones

ParameterSchema

---

buildProperty()

protected buildProperty(type): PropertySchema;

Definido en: cli/src/routeGeneration/routeGenerator.ts:219

Parámetros

type

Type

Devoluciones

PropertySchema

---

buildPropertySchema()

protected buildPropertySchema(source): PropertySchema;

Definido en: cli/src/routeGeneration/routeGenerator.ts:188

Parámetros

source

Property

Devoluciones

PropertySchema

---

GenerateCustomRoutes()

abstract GenerateCustomRoutes(): Promise<void>;

Definido en: cli/src/routeGeneration/routeGenerator.ts:20

Genera la salida de ruta configurada para el marco activo o plantilla personalizada.

Devoluciones

Promise<void>

---

getRelativeImportPath()

protected getRelativeImportPath(fileLocation): string;

Definido en: cli/src/routeGeneration/routeGenerator.ts:176

Parámetros

fileLocation

string

Devoluciones

string

---

pathTransformer()

protected pathTransformer(path): string;

Definido en: cli/src/routeGeneration/routeGenerator.ts:71

Parámetros

path

string

Devoluciones

string

---

shouldWriteFile()

protected shouldWriteFile(fileName, content): Promise<boolean>;

Definido en: cli/src/routeGeneration/routeGenerator.ts:263

Parámetros

fileName

string

content

string

Devoluciones

Promise<boolean>

Contributors

No contributors

Changelog

No recent changes