tsoa-next / tsoa-next / TemplateService

摘要类:模板服务<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:9

共享生成路由所使用的运行时间特定模板服务的基类.

由

• ExpressTemplateService
• HapiTemplateService
• KoaTemplateService

类型参数

ApiHandlerParameters

ApiHandlerParameters

ValidationArgsParameters

ValidationArgsParameters

ReturnHandlerParameters

ReturnHandlerParameters

构造器

构造器

new TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>(models, config): TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:12

参数

models

Models

config

AdditionalProps

回返

TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

属性

config

protected readonly config: AdditionalProps;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:14

---

models

protected readonly models: Models;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:13

---

validationService

protected validationService: ValidationService;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:10

方法

apiHandler()

abstract apiHandler(params): Promise<unknown>;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:20

为活动的运行时间启动控制器动作 。

参数

params

ApiHandlerParameters

回返

Promise<unknown>

---

buildPromise()

protected buildPromise(
   methodName, 
   controller, 
validatedArgs): Promise<unknown>;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:77

参数

methodName

string

controller

object | Controller

validatedArgs

unknown[]

回返

Promise<unknown>

---

getBodyProperty()

protected getBodyProperty(
   body, 
   headers, 
   propertyName): unknown;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:62

参数

body

unknown

headers

Record<string, unknown>

propertyName

string

回返

unknown

---

getValidatedArgs()

abstract getValidatedArgs(params): unknown[];

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:23

验证并规范从请求中提取的路由参数。

参数

params

ValidationArgsParameters

回返

unknown[]

---

isController()

protected isController(object): object is Controller;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:28

参数

object

object | Controller

回返

object is Controller

---

isRecord()

protected isRecord(value): value is Record<string, unknown>;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:73

参数

value

unknown

回返

value is Record<string, unknown>

---

normalizeRequestBody()

protected normalizeRequestBody(body, headers): unknown;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:54

参数

body

unknown

headers

Record<string, unknown>

回返

unknown

---

requestHasBody()

protected requestHasBody(headers): boolean;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:32

参数

headers

Record<string, unknown>

回返

boolean

---

requestUsesTransferEncoding()

protected requestUsesTransferEncoding(headers): boolean;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:50

参数

headers

Record<string, unknown>

回返

boolean

---

returnHandler()

abstract protected returnHandler(params): unknown;

定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:26

写入控制器返回活动运行时间 。

参数

params

ReturnHandlerParameters

回返

unknown

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史