Class KoaTemplateService

Hierarchy (View Summary)

TemplateService<
    KoaApiHandlerParameters,
    KoaValidationArgsParameters,
    KoaReturnHandlerParameters,
>
- KoaTemplateService

Index

Constructors

Properties

config models validationService

Methods

apiHandler buildPromise getValidatedArgs isController returnHandler

Constructors

constructor

new KoaTemplateService(
models: TsoaRoute.Models,
config: AdditionalProps,
): KoaTemplateService
Parameters
- models: TsoaRoute.Models
- config: AdditionalProps
Returns KoaTemplateService
Inherited from TemplateService.constructor
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:9

Properties

`Protected` `Readonly`config

config: AdditionalProps

`Protected` `Readonly`models

models: TsoaRoute.Models

`Protected`validationService

validationService: ValidationService

Methods

apiHandler

apiHandler(params: KoaApiHandlerParameters): Promise<any>
Parameters
- params: KoaApiHandlerParameters
Returns Promise<any>
Overrides TemplateService.apiHandler
- Defined in packages/runtime/dist/routeGeneration/templates/koa/koaTemplateService.d.ts:25

`Protected`buildPromise

buildPromise(
    methodName: string,
    controller: object | Controller,
    validatedArgs: any,
): Promise<any>
Parameters
- methodName: string
- controller: object | Controller
- validatedArgs: any
Returns Promise<any>
Inherited from TemplateService.buildPromise
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:14

getValidatedArgs

getValidatedArgs(params: KoaValidationArgsParameters): any[]
Parameters
- params: KoaValidationArgsParameters
Returns any[]
Overrides TemplateService.getValidatedArgs
- Defined in packages/runtime/dist/routeGeneration/templates/koa/koaTemplateService.d.ts:26

`Protected`isController

isController(object: object | Controller): object is Controller
Parameters
- object: object | Controller
Returns object is Controller
Inherited from TemplateService.isController
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:13

`Protected`returnHandler

returnHandler(
params: KoaReturnHandlerParameters,
): Promise<any> | Context | undefined
Parameters
- params: KoaReturnHandlerParameters
Returns Promise<any> | Context | undefined
Overrides TemplateService.returnHandler
- Defined in packages/runtime/dist/routeGeneration/templates/koa/koaTemplateService.d.ts:27