tsoa-next / @tsoa-next/runtime / KoaTemplateService
类: KoaTemplate 服务
定义如下: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:39
Koa- 具体执行生成的路由模板服务合同。
扩展
TemplateService<KoaApiHandlerParameters,KoaValidationArgsParameters,KoaReturnHandlerParameters>
构造器
构造器
new KoaTemplateService(models, config): KoaTemplateService;定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:12
参数
models
config
回返
KoaTemplateService
继承自
属性
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
继承自
TemplateService.validationService
方法
apiHandler()
apiHandler(params): Promise<void | Context>;定义如下: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:40
为活动的运行时间启动控制器动作 。
参数
params
KoaApiHandlerParameters
回返
Promise<void | Context>
覆盖
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
继承自
TemplateService.getBodyProperty
getValidatedArgs()
getValidatedArgs(params): unknown[];定义如下: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:64
验证并规范从请求中提取的路由参数。
参数
params
KoaValidationArgsParameters
回返
unknown[]
覆盖
TemplateService.getValidatedArgs
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
继承自
TemplateService.normalizeRequestBody
requestHasBody()
protected requestHasBody(headers): boolean;定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:32
参数
headers
Record<string, unknown>
回返
boolean
继承自
TemplateService.requestHasBody
requestUsesTransferEncoding()
protected requestUsesTransferEncoding(headers): boolean;定义如下: packages/runtime/src/routeGeneration/templates/templateService.ts:50
参数
headers
Record<string, unknown>
回返
boolean
继承自
TemplateService.requestUsesTransferEncoding
returnHandler()
protected returnHandler(params): Promise<void> | Context | undefined;定义如下: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:134
写入控制器返回活动运行时间 。
参数
params
KoaReturnHandlerParameters
回返
Promise<void> | Context | undefined
