Class AbstractRouteGenerator<Config>Abstract

Protected Readonlymetadata

Protected Readonlyoptions

ProtectedbuildContext

• buildContext(): {
      authenticationModule: string
      | undefined;
      basePath: string;
      canImportByAlias: boolean;
      controllers: {
          actions: {
              fullPath: string;
              method: string;
              name: string;
              parameters: { [name: string]: ParameterSchema };
              path: string;
              security: Security[];
              successStatus: string | number;
              uploadFile: boolean;
              uploadFileName: {
                  maxCount: number | undefined;
                  multiple: boolean;
                  name: string;
              }[];
          }[];
          modulePath: string;
          name: string;
          path: string;
      }[];
      environment: ProcessEnv;
      esm: boolean
      | undefined;
      iocModule: string | undefined;
      minimalSwaggerConfig: {
          bodyCoercion: boolean;
          noImplicitAdditionalProperties:
              | "ignore"
              | "throw-on-extras"
              | "silently-remove-extras";
      };
      models: Models;
      multerOpts: Config["multerOpts"];
      useFileUploads: boolean;
      useSecurity: boolean;
  }

  Returns {
      authenticationModule: string | undefined;
      basePath: string;
      canImportByAlias: boolean;
      controllers: {
          actions: {
              fullPath: string;
              method: string;
              name: string;
              parameters: { [name: string]: ParameterSchema };
              path: string;
              security: Security[];
              successStatus: string | number;
              uploadFile: boolean;
              uploadFileName: {
                  maxCount: number | undefined;
                  multiple: boolean;
                  name: string;
              }[];
          }[];
          modulePath: string;
          name: string;
          path: string;
      }[];
      environment: ProcessEnv;
      esm: boolean
      | undefined;
      iocModule: string | undefined;
      minimalSwaggerConfig: {
          bodyCoercion: boolean;
          noImplicitAdditionalProperties:
              | "ignore"
              | "throw-on-extras"
              | "silently-remove-extras";
      };
      models: Models;
      multerOpts: Config["multerOpts"];
      useFileUploads: boolean;
      useSecurity: boolean;
  }

ProtectedbuildParameterSchema

• buildParameterSchema(source: Parameter): ParameterSchema

  Parameters

  • source: Parameter

  Returns ParameterSchema

ProtectedbuildProperty

• buildProperty(type: Type): PropertySchema

  Parameters

  • type: Type

  Returns PropertySchema

ProtectedbuildPropertySchema

• buildPropertySchema(source: Property): PropertySchema

  Parameters

  • source: Property

  Returns PropertySchema

ProtectedgetRelativeImportPath

• getRelativeImportPath(fileLocation: string): string

  Parameters

  • fileLocation: string

  Returns string

ProtectedpathTransformer

• pathTransformer(path: string): string

  Parameters

  • path: string

  Returns string

ProtectedshouldWriteFile

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

  Parameters

  • fileName: string
  • content: string

  Returns Promise<boolean>