Saltar al contenido

tsoa-next / tsoa-next / ExpressTemplateService

Clase: ExpressTemplateService

Definido en: packages/runtime/src/routeGeneration/templates/express/expressTemplateService.ts:37

Express- Aplicación específica del contrato de servicio de plantilla de ruta generada.

Extensión

  • TemplateService<ExpressApiHandlerParameters, ExpressValidationArgsParameters, ExpressReturnHandlerParameters>

Constructores

Constructor

ts
new ExpressTemplateService(models, config): ExpressTemplateService;

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

Parámetros

models

Models

config

AdditionalProps

Devoluciones

ExpressTemplateService

Inhered from

TemplateService.constructor

Propiedades

config

ts
protected readonly config: AdditionalProps;

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

Inhered from

TemplateService.config


models

ts
protected readonly models: Models;

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

Inhered from

TemplateService.models


validationService

ts
protected validationService: ValidationService;

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

Inhered from

TemplateService.validationService

Métodos

apiHandler()

ts
apiHandler(params): Promise<void>;

Definido en: packages/runtime/src/routeGeneration/templates/express/expressTemplateService.ts:38

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

Parámetros

params

ExpressApiHandlerParameters

Devoluciones

Promise<void>

Anulaciones

TemplateService.apiHandler


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>

Inhered from

TemplateService.buildPromise


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

Inhered from

TemplateService.getBodyProperty


getValidatedArgs()

ts
getValidatedArgs(params): unknown[];

Definido en: packages/runtime/src/routeGeneration/templates/express/expressTemplateService.ts:56

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

Parámetros

params

ExpressValidationArgsParameters

Devoluciones

unknown[]

Anulaciones

TemplateService.getValidatedArgs


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

Inhered from

TemplateService.isController


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>

Inhered from

TemplateService.isRecord


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

Inhered from

TemplateService.normalizeRequestBody


requestHasBody()

ts
protected requestHasBody(headers): boolean;

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

Parámetros

headers

Record<string, unknown>

Devoluciones

boolean

Inhered from

TemplateService.requestHasBody


requestUsesTransferEncoding()

ts
protected requestUsesTransferEncoding(headers): boolean;

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

Parámetros

headers

Record<string, unknown>

Devoluciones

boolean

Inhered from

TemplateService.requestUsesTransferEncoding


returnHandler()

ts
protected returnHandler(params): void;

Definido en: packages/runtime/src/routeGeneration/templates/express/expressTemplateService.ts:126

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

Parámetros

params

ExpressReturnHandlerParameters

Devoluciones

void

Anulaciones

TemplateService.returnHandler

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.