tsoa-next / @tsoa-next/cli / AbstractRouteGenerator
Abstract Class: AbstractRouteGenerator<Config>
Defined in: cli/src/routeGeneration/routeGenerator.ts:11
Base implementation for route generators that transform metadata into framework-specific route files.
Extended by
Type Parameters
Config
Config extends ExtendedRoutesConfig
Constructors
Constructor
new AbstractRouteGenerator<Config>(metadata, options): AbstractRouteGenerator<Config>;Defined in: cli/src/routeGeneration/routeGenerator.ts:12
Parameters
metadata
Metadata
options
Config
Returns
AbstractRouteGenerator<Config>
Properties
metadata
protected readonly metadata: Metadata;Defined in: cli/src/routeGeneration/routeGenerator.ts:13
options
protected readonly options: Config;Defined in: cli/src/routeGeneration/routeGenerator.ts:14
Methods
buildContext()
protected buildContext(): object;Defined in: cli/src/routeGeneration/routeGenerator.ts:76
Builds the Handlebars template context used by the default route templates.
Returns
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.noImplicitAdditionalProperties
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;Defined in: cli/src/routeGeneration/routeGenerator.ts:157
Parameters
useSpecPaths
boolean
Returns
| { spec: Spec; yaml: string; } | undefined
buildModels()
buildModels(): Models;Defined in: cli/src/routeGeneration/routeGenerator.ts:23
Builds the runtime model metadata consumed by generated route handlers.
Returns
Models
buildParameterSchema()
protected buildParameterSchema(source): ParameterSchema;Defined in: cli/src/routeGeneration/routeGenerator.ts:199
Parameters
source
Parameter
Returns
ParameterSchema
buildProperty()
protected buildProperty(type): PropertySchema;Defined in: cli/src/routeGeneration/routeGenerator.ts:219
Parameters
type
Type
Returns
PropertySchema
buildPropertySchema()
protected buildPropertySchema(source): PropertySchema;Defined in: cli/src/routeGeneration/routeGenerator.ts:188
Parameters
source
Property
Returns
PropertySchema
GenerateCustomRoutes()
abstract GenerateCustomRoutes(): Promise<void>;Defined in: cli/src/routeGeneration/routeGenerator.ts:20
Generates the configured route output for the active framework or custom template.
Returns
Promise<void>
getRelativeImportPath()
protected getRelativeImportPath(fileLocation): string;Defined in: cli/src/routeGeneration/routeGenerator.ts:176
Parameters
fileLocation
string
Returns
string
pathTransformer()
protected pathTransformer(path): string;Defined in: cli/src/routeGeneration/routeGenerator.ts:71
Parameters
path
string
Returns
string
shouldWriteFile()
protected shouldWriteFile(fileName, content): Promise<boolean>;Defined in: cli/src/routeGeneration/routeGenerator.ts:263
Parameters
fileName
string
content
string
Returns
Promise<boolean>