tsoa-next / @tsoa-next/cli / AbstractRouteGenerator

सार क्लास: सारमार्गमार्ग जनरेटर<Config>

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:11

मार्ग जनरेटर के लिए बेस कार्यान्वयन जो मेटाडाटा को फ्रेमवर्क-विशिष्ट मार्ग फ़ाइलों में बदल देता है।

द्वारा विस्तारित

• DefaultRouteGenerator

प्रकार पैरामीटर

Config

Config * ExtendedRoutesConfig

कंस्ट्रक्टर

रचनाकार

new AbstractRouteGenerator<Config>(metadata, options): AbstractRouteGenerator<Config>;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:12

पैरामीटर

metadata

Metadata

options

Config

रिटर्न

AbstractRouteGenerator<Config>

गुण

metadata

protected readonly metadata: Metadata;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:13

---

options

protected readonly options: Config;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:14

विधि

buildContext()

protected buildContext(): object;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:76

बनाता है Handlebars डिफ़ॉल्ट मार्ग टेम्पलेट्स द्वारा उपयोग किए जाने वाले टेम्पलेट संदर्भ।

रिटर्न

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;

न्यूनतमSwaggerConfig.bodyCoercion

bodyCoercion: boolean;

न्यूनतमSwaggerConfig.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;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:157

पैरामीटर

useSpecPaths

boolean

रिटर्न

| { spec: Spec; yaml: string; } | undefined

---

buildModels()

buildModels(): Models;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:23

उत्पन्न रूट हैंडलर्स द्वारा खपत रनटाइम मॉडल मेटाडाटा बनाता है।

रिटर्न

Models

---

buildParameterSchema()

protected buildParameterSchema(source): ParameterSchema;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:199

पैरामीटर

source

Parameter

रिटर्न

ParameterSchema

---

buildProperty()

protected buildProperty(type): PropertySchema;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:219

पैरामीटर

type

Type

रिटर्न

PropertySchema

---

buildPropertySchema()

protected buildPropertySchema(source): PropertySchema;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:188

पैरामीटर

source

Property

रिटर्न

PropertySchema

---

GenerateCustomRoutes()

abstract GenerateCustomRoutes(): Promise<void>;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:20

सक्रिय ढांचे या कस्टम टेम्पलेट के लिए कॉन्फ़िगर रूट आउटपुट उत्पन्न करता है।

रिटर्न

Promise<void>

---

getRelativeImportPath()

protected getRelativeImportPath(fileLocation): string;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:176

पैरामीटर

fileLocation

string

रिटर्न

string

---

pathTransformer()

protected pathTransformer(path): string;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:71

पैरामीटर

path

string

रिटर्न

string

---

shouldWriteFile()

protected shouldWriteFile(fileName, content): Promise<boolean>;

में परिभाषित: cli/src/routeGeneration/routeGenerator.ts:263

पैरामीटर

fileName

string

content

string

रिटर्न

Promise<boolean>

Contributors

No contributors

Changelog

No recent changes