Skip to content

tsoa-next / @tsoa-next/runtime / HapiTemplateService

Class: HapiTemplateService ​

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:45

Hapi-specific implementation of the generated route template service contract.

Extends ​

  • TemplateService<HapiApiHandlerParameters, HapiValidationArgsParameters, HapiReturnHandlerParameters>

Constructors ​

Constructor ​

ts
new HapiTemplateService(
   models, 
   config, 
   hapi): HapiTemplateService;

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:46

Parameters ​

models ​

Models

config ​

AdditionalProps

hapi ​
boomify ​
isBoom ​

Returns ​

HapiTemplateService

Overrides ​

TemplateService.constructor

Properties ​

config ​

ts
protected readonly config: AdditionalProps;

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:48

Inherited from ​

TemplateService.config


models ​

ts
protected readonly models: Models;

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:47

Inherited from ​

TemplateService.models


validationService ​

ts
protected validationService: ValidationService;

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

Inherited from ​

TemplateService.validationService

Methods ​

apiHandler() ​

ts
apiHandler(params): Promise<unknown>;

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:57

Invokes the controller action for the active runtime.

Parameters ​

params ​

HapiApiHandlerParameters

Returns ​

Promise<unknown>

Overrides ​

TemplateService.apiHandler


buildPromise() ​

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

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

Parameters ​

methodName ​

string

controller ​

object | Controller

validatedArgs ​

unknown[]

Returns ​

Promise<unknown>

Inherited from ​

TemplateService.buildPromise


getBodyProperty() ​

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

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

Parameters ​

body ​

unknown

headers ​

Record<string, unknown>

propertyName ​

string

Returns ​

unknown

Inherited from ​

TemplateService.getBodyProperty


getValidatedArgs() ​

ts
getValidatedArgs(params): unknown[];

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:88

Validates and normalizes the route arguments extracted from the request.

Parameters ​

params ​

HapiValidationArgsParameters

Returns ​

unknown[]

Overrides ​

TemplateService.getValidatedArgs


isController() ​

ts
protected isController(object): object is Controller;

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

Parameters ​

object ​

object | Controller

Returns ​

object is Controller

Inherited from ​

TemplateService.isController


isRecord() ​

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

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

Parameters ​

value ​

unknown

Returns ​

value is Record<string, unknown>

Inherited from ​

TemplateService.isRecord


normalizeRequestBody() ​

ts
protected normalizeRequestBody(body, headers): unknown;

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

Parameters ​

body ​

unknown

headers ​

Record<string, unknown>

Returns ​

unknown

Inherited from ​

TemplateService.normalizeRequestBody


requestHasBody() ​

ts
protected requestHasBody(headers): boolean;

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

Parameters ​

headers ​

Record<string, unknown>

Returns ​

boolean

Inherited from ​

TemplateService.requestHasBody


requestUsesTransferEncoding() ​

ts
protected requestUsesTransferEncoding(headers): boolean;

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

Parameters ​

headers ​

Record<string, unknown>

Returns ​

boolean

Inherited from ​

TemplateService.requestUsesTransferEncoding


returnHandler() ​

ts
protected returnHandler(params): unknown;

Defined in: packages/runtime/src/routeGeneration/templates/hapi/hapiTemplateService.ts:148

Writes the controller result back to the active runtime.

Parameters ​

params ​

HapiReturnHandlerParameters

Returns ​

unknown

Overrides ​

TemplateService.returnHandler

TypeScript-first OpenAPI generation, route generation, and runtime validation.