- Preparing search index...
- The search index is not available
tsoa
Class AbstractRouteGenerator<Config>Abstract
Constructors
constructor
- new AbstractRouteGenerator<Config>(metadata: Tsoa.Metadata, options: Config): AbstractRouteGenerator<Config>
-
Properties
Protected Readonly metadata
Protected Readonly options
options: Config
Methods
Abstract GenerateCustomRoutes
- GenerateCustomRoutes(): Promise<void>
-
Returns Promise<void>
Protected buildContext
- buildContext(): {
authenticationModule: undefined | string;
basePath: string;
canImportByAlias: boolean;
controllers: {
actions: {
fullPath: string;
method: string;
name: string;
parameters: {
[name: string]: TsoaRoute.ParameterSchema;
};
path: string;
security: Tsoa.Security[];
successStatus: string | number;
uploadFile: boolean;
uploadFileName: undefined | string;
uploadFiles: boolean;
uploadFilesName: undefined | string;
}[];
modulePath: string;
name: string;
path: string;
}[];
environment: ProcessEnv;
esm: undefined | boolean;
iocModule: undefined | string;
minimalSwaggerConfig: {
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
};
models: TsoaRoute.Models;
multerOpts: undefined | Options;
useFileUploads: boolean;
useSecurity: boolean;
}
-
Returns {
authenticationModule: undefined | string;
basePath: string;
canImportByAlias: boolean;
controllers: {
actions: {
fullPath: string;
method: string;
name: string;
parameters: {
[name: string]: TsoaRoute.ParameterSchema;
};
path: string;
security: Tsoa.Security[];
successStatus: string | number;
uploadFile: boolean;
uploadFileName: undefined | string;
uploadFiles: boolean;
uploadFilesName: undefined | string;
}[];
modulePath: string;
name: string;
path: string;
}[];
environment: ProcessEnv;
esm: undefined | boolean;
iocModule: undefined | string;
minimalSwaggerConfig: {
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
};
models: TsoaRoute.Models;
multerOpts: undefined | Options;
useFileUploads: boolean;
useSecurity: boolean;
}
-
authenticationModule: undefined | string
-
basePath: string
-
canImportByAlias: boolean
-
controllers: {
actions: {
fullPath: string;
method: string;
name: string;
parameters: {
[name: string]: TsoaRoute.ParameterSchema;
};
path: string;
security: Tsoa.Security[];
successStatus: string | number;
uploadFile: boolean;
uploadFileName: undefined | string;
uploadFiles: boolean;
uploadFilesName: undefined | string;
}[];
modulePath: string;
name: string;
path: string;
}[]
-
environment: ProcessEnv
-
esm: undefined | boolean
-
iocModule: undefined | string
-
minimalSwaggerConfig: {
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
}
-
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras"
-
-
multerOpts: undefined | Options
-
useFileUploads: boolean
-
useSecurity: boolean
buildModels
- buildModels(): TsoaRoute.Models
-
Protected buildParameterSchema
Protected buildPropertySchema
Protected getRelativeImportPath
- getRelativeImportPath(fileLocation: string): string
-
Returns string
Protected pathTransformer
- pathTransformer(path: string): string
-
Returns string
Protected shouldWriteFile
- shouldWriteFile(fileName: string, content: string): Promise<boolean>
-
Parameters
-
fileName: string
-
content: string
Returns Promise<boolean>
This is the entrypoint for a generator to create a custom set of routes