Class ExpressTemplateService

Hierarchy (View Summary)

TemplateService<
    ExpressApiHandlerParameters,
    ExpressValidationArgsParameters,
    ExpressReturnHandlerParameters,
>
- ExpressTemplateService

Index

Constructors

Properties

config models validationService

Methods

apiHandler buildPromise getBodyProperty getValidatedArgs isController isRecord normalizeRequestBody requestHasBody requestUsesTransferEncoding returnHandler

Constructors

constructor

new ExpressTemplateService(
models: TsoaRoute.Models,
config: AdditionalProps,
): ExpressTemplateService
Parameters
- models: TsoaRoute.Models
- config: AdditionalProps
Returns ExpressTemplateService
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: ExpressApiHandlerParameters): Promise<void>
Parameters
- params: ExpressApiHandlerParameters
Returns Promise<void>
Overrides TemplateService.apiHandler
- Defined in packages/runtime/dist/routeGeneration/templates/express/expressTemplateService.d.ts:26

`Protected`buildPromise

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

`Protected`getBodyProperty

getBodyProperty(
    body: unknown,
    headers: Record<string, unknown>,
    propertyName: string,
): unknown
Parameters
- body: unknown
- headers: Record<string, unknown>
- propertyName: string
Returns unknown
Inherited from TemplateService.getBodyProperty
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:17

getValidatedArgs

getValidatedArgs(params: ExpressValidationArgsParameters): unknown[]
Parameters
- params: ExpressValidationArgsParameters
Returns unknown[]
Overrides TemplateService.getValidatedArgs
- Defined in packages/runtime/dist/routeGeneration/templates/express/expressTemplateService.d.ts:27

`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`isRecord

isRecord(value: unknown): value is Record<string, unknown>
Parameters
- value: unknown
Returns value is Record<string, unknown>
Inherited from TemplateService.isRecord
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:18

`Protected`normalizeRequestBody

normalizeRequestBody(body: unknown, headers: Record<string, unknown>): unknown
Parameters
- body: unknown
- headers: Record<string, unknown>
Returns unknown
Inherited from TemplateService.normalizeRequestBody
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:16

`Protected`requestHasBody

requestHasBody(headers: Record<string, unknown>): boolean
Parameters
- headers: Record<string, unknown>
Returns boolean
Inherited from TemplateService.requestHasBody
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:14

`Protected`requestUsesTransferEncoding

requestUsesTransferEncoding(headers: Record<string, unknown>): boolean
Parameters
- headers: Record<string, unknown>
Returns boolean
Inherited from TemplateService.requestUsesTransferEncoding
- Defined in packages/runtime/dist/routeGeneration/templates/templateService.d.ts:15

`Protected`returnHandler

returnHandler(params: ExpressReturnHandlerParameters): void
Parameters
- params: ExpressReturnHandlerParameters
Returns void
Overrides TemplateService.returnHandler
- Defined in packages/runtime/dist/routeGeneration/templates/express/expressTemplateService.d.ts:28