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;

最小Swagger Config.body 强制化

bodyCoercion: boolean;

最小Swagger 配置. no Implicial 附加品

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

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史