tsoa-next / tsoa-next / TemplateService

Abstract Class: TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:9

Shared base class for runtime-specific template services used by generated routes.

Extended by

• ExpressTemplateService
• HapiTemplateService
• KoaTemplateService

Type Parameters

ApiHandlerParameters

ApiHandlerParameters

ValidationArgsParameters

ValidationArgsParameters

ReturnHandlerParameters

ReturnHandlerParameters

Constructors

Constructor

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

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:12

Parameters

models

Models

config

AdditionalProps

Returns

TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

Properties

config

protected readonly config: AdditionalProps;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:14

---

models

protected readonly models: Models;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:13

---

validationService

protected validationService: ValidationService;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:10

Methods

apiHandler()

abstract apiHandler(params): Promise<unknown>;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:20

Invokes the controller action for the active runtime.

Parameters

params

ApiHandlerParameters

Returns

Promise<unknown>

---

buildPromise()

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

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:77

Parameters

methodName

string

controller

object | Controller

validatedArgs

unknown[]

Returns

Promise<unknown>

---

getBodyProperty()

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

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:62

Parameters

body

unknown

headers

Record<string, unknown>

propertyName

string

Returns

unknown

---

getValidatedArgs()

abstract getValidatedArgs(params): unknown[];

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:23

Validates and normalizes the route arguments extracted from the request.

Parameters

params

ValidationArgsParameters

Returns

unknown[]

---

isController()

protected isController(object): object is Controller;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:28

Parameters

object

object | Controller

Returns

object is Controller

---

isRecord()

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

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:73

Parameters

value

unknown

Returns

value is Record<string, unknown>

---

normalizeRequestBody()

protected normalizeRequestBody(body, headers): unknown;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:54

Parameters

body

unknown

headers

Record<string, unknown>

Returns

unknown

---

requestHasBody()

protected requestHasBody(headers): boolean;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:32

Parameters

headers

Record<string, unknown>

Returns

boolean

---

requestUsesTransferEncoding()

protected requestUsesTransferEncoding(headers): boolean;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:50

Parameters

headers

Record<string, unknown>

Returns

boolean

---

returnHandler()

abstract protected returnHandler(params): unknown;

Defined in: packages/runtime/src/routeGeneration/templates/templateService.ts:26

Writes the controller result back to the active runtime.

Parameters

params

ReturnHandlerParameters

Returns

unknown