Class DefaultRouteGenerator

Hierarchy (view full)

Constructors

constructor

Properties

metadata options pathTransformerFn template

Methods

GenerateCustomRoutes GenerateRoutes buildContent buildContext buildModels buildParameterSchema buildProperty buildPropertySchema getRelativeImportPath pathTransformer shouldWriteFile

Constructors

constructor

Properties

Protected Readonly metadata

metadata: Tsoa.Metadata

Protected Readonly options

options: ExtendedRoutesConfig

pathTransformerFn

pathTransformerFn: ((path) => string)

Type declaration

    • (path): string

    • Parameters

      • path: string

      Returns string

template

template: string

Methods

GenerateCustomRoutes

  • GenerateCustomRoutes(): Promise<void>

  • This is the entrypoint for a generator to create a custom set of routes

    Returns Promise<void>

GenerateRoutes

  • GenerateRoutes(middlewareTemplate): Promise<void>

  • Parameters

    • middlewareTemplate: string

    Returns Promise<void>

buildContent

  • buildContent(middlewareTemplate): string

  • Parameters

    • middlewareTemplate: string

    Returns string

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: {
                    name: string;
                }[];
                uploadFiles: boolean;
                uploadFilesName: undefined | string;
            }[];
            modulePath: string;
            name: string;
            path: string;
        }[];
        environment: ProcessEnv;
        esm: undefined | boolean;
        iocModule: undefined | string;
        minimalSwaggerConfig: {
            bodyCoercion: boolean;
            noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
        };
        models: TsoaRoute.Models;
        multerOpts: {
            dest?: string;
            fileFilter?: ((req, file, callback) => void);
            limits: {
                fieldNameSize?: number;
                fieldSize?: number;
                fields?: number;
                fileSize?: number;
                files?: number;
                headerPairs?: number;
                parts?: number;
            };
            preservePath?: boolean;
            storage?: StorageEngine;
        };
        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: {
                    name: string;
                }[];
                uploadFiles: boolean;
                uploadFilesName: undefined | string;
            }[];
            modulePath: string;
            name: string;
            path: string;
        }[];
        environment: ProcessEnv;
        esm: undefined | boolean;
        iocModule: undefined | string;
        minimalSwaggerConfig: {
            bodyCoercion: boolean;
            noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
        };
        models: TsoaRoute.Models;
        multerOpts: {
            dest?: string;
            fileFilter?: ((req, file, callback) => void);
            limits: {
                fieldNameSize?: number;
                fieldSize?: number;
                fields?: number;
                fileSize?: number;
                files?: number;
                headerPairs?: number;
                parts?: number;
            };
            preservePath?: boolean;
            storage?: StorageEngine;
        };
        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: {
                  name: string;
              }[];
              uploadFiles: boolean;
              uploadFilesName: undefined | string;
          }[];
          modulePath: string;
          name: string;
          path: string;
      }[]
    • environment: ProcessEnv
    • esm: undefined | boolean
    • iocModule: undefined | string
    • minimalSwaggerConfig: {
          bodyCoercion: boolean;
          noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";
      }
      • bodyCoercion: boolean
      • noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras"
    • models: TsoaRoute.Models
    • multerOpts: {
          dest?: string;
          fileFilter?: ((req, file, callback) => void);
          limits: {
              fieldNameSize?: number;
              fieldSize?: number;
              fields?: number;
              fileSize?: number;
              files?: number;
              headerPairs?: number;
              parts?: number;
          };
          preservePath?: boolean;
          storage?: StorageEngine;
      }
      • Optional dest?: string
      • Optional fileFilter?: ((req, file, callback) => void)
          • (req, file, callback): void

          • Parameters

            • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
            • file: File
            • callback: FileFilterCallback

            Returns void

      • limits: {
            fieldNameSize?: number;
            fieldSize?: number;
            fields?: number;
            fileSize?: number;
            files?: number;
            headerPairs?: number;
            parts?: number;
        }
        • Optional fieldNameSize?: number
        • Optional fieldSize?: number
        • Optional fields?: number
        • Optional fileSize?: number
        • Optional files?: number
        • Optional headerPairs?: number
        • Optional parts?: number
      • Optional preservePath?: boolean
      • Optional storage?: StorageEngine
    • useFileUploads: boolean
    • useSecurity: boolean

buildModels

Protected buildParameterSchema

Protected buildProperty

Protected buildPropertySchema

Protected getRelativeImportPath

Protected pathTransformer

  • pathTransformer(path): string

  • Parameters

    • path: string

    Returns string

Protected shouldWriteFile

  • shouldWriteFile(fileName, content): Promise<boolean>

  • Parameters

    • fileName: string
    • content: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

constructormetadataoptionspathTransformerFntemplateGenerateCustomRoutesGenerateRoutesbuildContentbuildContextbuildModelsbuildParameterSchemabuildPropertybuildPropertySchemagetRelativeImportPathpathTransformershouldWriteFile

Generated using TypeDoc