tsoa-next / @tsoa-next/cli / DefaultRouteGenerator

वर्ग: डिफ़ॉल्टरूटजेनरेटर

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

अंतर्निहित के लिए डिफ़ॉल्ट मार्ग जनरेटर Express, Koa, और Hapi टेम्पलेट्स।

विस्तार

• AbstractRouteGenerator<ExtendedRoutesConfig>

कंस्ट्रक्टर

रचनाकार

new DefaultRouteGenerator(metadata, options): DefaultRouteGenerator;

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

पैरामीटर

metadata

Metadata

options

ExtendedRoutesConfig

रिटर्न

DefaultRouteGenerator

ओवरराइड

AbstractRouteGenerator.constructor

गुण

metadata

protected readonly metadata: Metadata;

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

से विरासत

AbstractRouteGenerator.metadata

---

options

protected readonly options: ExtendedRoutesConfig;

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

से विरासत

AbstractRouteGenerator.options

---

pathTransformerFn

pathTransformerFn: (path) => string;

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

पैरामीटर

path

string

रिटर्न

string

---

template

template: string;

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

विधि

buildContent()

buildContent(middlewareTemplate): string;

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

वर्तमान मेटाडाटा संदर्भ के साथ मार्ग टेम्पलेट प्रस्तुत करता है।

पैरामीटर

middlewareTemplate

string

रिटर्न

string

---

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: Options | undefined;

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;

से विरासत

AbstractRouteGenerator.buildContext

---

buildEmbeddedSpecGeneratorArtifacts()

protected buildEmbeddedSpecGeneratorArtifacts(useSpecPaths): 
  | {
  spec: Spec;
  yaml: string;
}
  | undefined;

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

पैरामीटर

useSpecPaths

boolean

रिटर्न

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

से विरासत

AbstractRouteGenerator.buildEmbeddedSpecGeneratorArtifacts

---

buildModels()

buildModels(): Models;

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

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

रिटर्न

Models

से विरासत

AbstractRouteGenerator.buildModels

---

buildParameterSchema()

protected buildParameterSchema(source): ParameterSchema;

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

पैरामीटर

source

Parameter

रिटर्न

ParameterSchema

से विरासत

AbstractRouteGenerator.buildParameterSchema

---

buildProperty()

protected buildProperty(type): PropertySchema;

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

पैरामीटर

type

Type

रिटर्न

PropertySchema

से विरासत

AbstractRouteGenerator.buildProperty

---

buildPropertySchema()

protected buildPropertySchema(source): PropertySchema;

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

पैरामीटर

source

Property

रिटर्न

PropertySchema

से विरासत

AbstractRouteGenerator.buildPropertySchema

---

GenerateCustomRoutes()

GenerateCustomRoutes(): Promise<void>;

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

चयनित टेम्पलेट फ़ाइल को लोड करता है और रूट आउटपुट उत्पन्न करता है।

रिटर्न

Promise<void>

ओवरराइड

AbstractRouteGenerator.GenerateCustomRoutes

---

GenerateRoutes()

GenerateRoutes(middlewareTemplate): Promise<void>;

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

उत्पन्न रूट फ़ाइल को डिस्क में लिखते हैं।

पैरामीटर

middlewareTemplate

string

रिटर्न

Promise<void>

---

getRelativeImportPath()

protected getRelativeImportPath(fileLocation): string;

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

पैरामीटर

fileLocation

string

रिटर्न

string

से विरासत

AbstractRouteGenerator.getRelativeImportPath

---

pathTransformer()

protected pathTransformer(path): string;

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

पैरामीटर

path

string

रिटर्न

string

ओवरराइड

AbstractRouteGenerator.pathTransformer

---

shouldWriteFile()

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

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

पैरामीटर

fileName

string

content

string

रिटर्न

Promise<boolean>

से विरासत

AbstractRouteGenerator.shouldWriteFile

Contributors

No contributors

Changelog

No recent changes