Class DefaultRouteGenerator

Hierarchy

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) => string)

Type declaration

    • (path: string): string

    • Parameters

      • path: string

      Returns string

template

template: string

Methods

GenerateCustomRoutes

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

    Returns Promise<void>

GenerateRoutes

  • Parameters

    • middlewareTemplate: string

    Returns Promise<void>

buildContent

  • Parameters

    • middlewareTemplate: string

    Returns string

Protected buildContext

  • 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"
    • models: TsoaRoute.Models
    • multerOpts: undefined | Options
    • useFileUploads: boolean
    • useSecurity: boolean

buildModels

Protected buildParameterSchema

Protected buildProperty

Protected buildPropertySchema

Protected getRelativeImportPath

  • Parameters

    • fileLocation: string

    Returns string

Protected pathTransformer

  • Parameters

    • path: string

    Returns string

Protected shouldWriteFile

  • Parameters

    • fileName: string
    • content: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc