tsoa-next / tsoa-next / KoaTemplateService

Clase: KoaTemplateService

Definido en: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:39

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

Extensión

• TemplateService<KoaApiHandlerParameters, KoaValidationArgsParameters, KoaReturnHandlerParameters>

Constructores

Constructor

new KoaTemplateService(models, config): KoaTemplateService;

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

Parámetros

models

Models

config

AdditionalProps

Devoluciones

KoaTemplateService

Inhered from

TemplateService.constructor

Propiedades

config

protected readonly config: AdditionalProps;

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

Inhered from

TemplateService.config

---

models

protected readonly models: Models;

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

Inhered from

TemplateService.models

---

validationService

protected validationService: ValidationService;

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

Inhered from

TemplateService.validationService

Métodos

apiHandler()

apiHandler(params): Promise<void | Context>;

Definido en: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:40

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

Parámetros

params

KoaApiHandlerParameters

Devoluciones

Promise<void | Context>

Anulaciones

TemplateService.apiHandler

---

buildPromise()

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()

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()

getValidatedArgs(params): unknown[];

Definido en: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:64

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

Parámetros

params

KoaValidationArgsParameters

Devoluciones

unknown[]

Anulaciones

TemplateService.getValidatedArgs

---

isController()

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()

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()

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()

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()

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()

protected returnHandler(params): Promise<void> | Context | undefined;

Definido en: packages/runtime/src/routeGeneration/templates/koa/koaTemplateService.ts:134

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

Parámetros

params

KoaReturnHandlerParameters

Devoluciones

Promise<void> | Context | undefined

Anulaciones

TemplateService.returnHandler

Contributors

No contributors

Changelog

No recent changes