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

الرتبة: مصمم طرق

محددة في: cli/src/routeGeneration/defaultRouteGenerator.ts:11

المولد الافتراضي للطريق Express.. Koaو Hapi نماذج

التذييلات

• AbstractRouteGenerator<ExtendedRoutesConfig>

Constructors

المؤسسة

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

Inherited from

AbstractRouteGenerator.metadata

---

options

protected readonly options: ExtendedRoutesConfig;

محددة في: cli/src/routeGeneration/routeGenerator.ts:14

Inherited from

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;

الحد الأدنى من المصارعة

bodyCoercion: boolean;

الحد الأدنى من المواد الكيميائية

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;

Inherited from

AbstractRouteGenerator.buildContext

---

buildEmbeddedSpecGeneratorArtifacts()

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

محددة في: cli/src/routeGeneration/routeGenerator.ts:157

البارامترات

useSpecPaths

boolean

العودة

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

Inherited from

AbstractRouteGenerator.buildEmbeddedSpecGeneratorArtifacts

---

buildModels()

buildModels(): Models;

محددة في: cli/src/routeGeneration/routeGenerator.ts:23

يبني نموذج البيانات الفوقية التي يستهلكها معالجو الطرق المولدون.

العودة

Models

Inherited from

AbstractRouteGenerator.buildModels

---

buildParameterSchema()

protected buildParameterSchema(source): ParameterSchema;

محددة في: cli/src/routeGeneration/routeGenerator.ts:199

البارامترات

source

Parameter

العودة

ParameterSchema

Inherited from

AbstractRouteGenerator.buildParameterSchema

---

buildProperty()

protected buildProperty(type): PropertySchema;

محددة في: cli/src/routeGeneration/routeGenerator.ts:219

البارامترات

type

Type

العودة

PropertySchema

Inherited from

AbstractRouteGenerator.buildProperty

---

buildPropertySchema()

protected buildPropertySchema(source): PropertySchema;

محددة في: cli/src/routeGeneration/routeGenerator.ts:188

البارامترات

source

Property

العودة

PropertySchema

Inherited from

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

Inherited from

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>

Inherited from

AbstractRouteGenerator.shouldWriteFile

Contributors

No contributors

Changelog

No recent changes