Saltar al contenido

tsoa-next / tsoa-next / TemplateService

Clase abstracta: PlantillaServicio<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters> ​

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:9

Clase base compartida para los servicios de plantilla específicos de tiempo de ejecución utilizados por rutas generadas.

Extendido por ​

Parámetros tipo ​

ApiHandlerParameters ​

ApiHandlerParameters

ValidationArgsParameters ​

ValidationArgsParameters

ReturnHandlerParameters ​

ReturnHandlerParameters

Constructores ​

Constructor ​

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

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:12

Parámetros ​

models ​

Models

config ​

AdditionalProps

Devoluciones ​

TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

Propiedades ​

config ​

ts
protected readonly config: AdditionalProps;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:14


models ​

ts
protected readonly models: Models;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:13


validationService ​

ts
protected validationService: ValidationService;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:10

Métodos ​

apiHandler() ​

ts
abstract apiHandler(params): Promise<unknown>;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:20

Invoca la acción del controlador para el tiempo de funcionamiento activo.

Parámetros ​

params ​

ApiHandlerParameters

Devoluciones ​

Promise<unknown>


buildPromise() ​

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

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:77

Parámetros ​

methodName ​

string

controller ​

object | Controller

validatedArgs ​

unknown[]

Devoluciones ​

Promise<unknown>


getBodyProperty() ​

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

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:62

Parámetros ​

body ​

unknown

headers ​

Record<string, unknown>

propertyName ​

string

Devoluciones ​

unknown


getValidatedArgs() ​

ts
abstract getValidatedArgs(params): unknown[];

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:23

Valida y normaliza los argumentos de la ruta extraídos de la solicitud.

Parámetros ​

params ​

ValidationArgsParameters

Devoluciones ​

unknown[]


isController() ​

ts
protected isController(object): object is Controller;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:28

Parámetros ​

object ​

object | Controller

Devoluciones ​

object is Controller


isRecord() ​

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

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:73

Parámetros ​

value ​

unknown

Devoluciones ​

value is Record<string, unknown>


normalizeRequestBody() ​

ts
protected normalizeRequestBody(body, headers): unknown;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:54

Parámetros ​

body ​

unknown

headers ​

Record<string, unknown>

Devoluciones ​

unknown


requestHasBody() ​

ts
protected requestHasBody(headers): boolean;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:32

Parámetros ​

headers ​

Record<string, unknown>

Devoluciones ​

boolean


requestUsesTransferEncoding() ​

ts
protected requestUsesTransferEncoding(headers): boolean;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:50

Parámetros ​

headers ​

Record<string, unknown>

Devoluciones ​

boolean


returnHandler() ​

ts
abstract protected returnHandler(params): unknown;

Definido en: packages/runtime/src/routeGeneration/templates/templateService.ts:26

Escribe el resultado del controlador de vuelta al tiempo de funcionamiento activo.

Parámetros ​

params ​

ReturnHandlerParameters

Devoluciones ​

unknown

Contributors

No contributors

Changelog

No recent changes

Generación de OpenAPI, generación de rutas y validación en tiempo de ejecución con prioridad en TypeScript.