tsoa-next / tsoa-next / TemplateService

सार वर्ग: टेम्पलेटसेवा<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:9

उत्पन्न मार्गों द्वारा उपयोग की जाने वाली रनटाइम-विशिष्ट टेम्पलेट सेवाओं के लिए साझा आधार वर्ग।

द्वारा विस्तारित

• ExpressTemplateService
• HapiTemplateService
• KoaTemplateService

प्रकार पैरामीटर

ApiHandlerParameters

ApiHandlerParameters

ValidationArgsParameters

ValidationArgsParameters

ReturnHandlerParameters

ReturnHandlerParameters

कंस्ट्रक्टर

रचनाकार

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

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:12

पैरामीटर

models

Models

config

AdditionalProps

रिटर्न

TemplateService<ApiHandlerParameters, ValidationArgsParameters, ReturnHandlerParameters>

गुण

config

protected readonly config: AdditionalProps;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:14

---

models

protected readonly models: Models;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:13

---

validationService

protected validationService: ValidationService;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:10

विधि

apiHandler()

abstract apiHandler(params): Promise<unknown>;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:20

सक्रिय रनटाइम के लिए नियंत्रक कार्रवाई को आमंत्रित करता है।

पैरामीटर

params

ApiHandlerParameters

रिटर्न

Promise<unknown>

---

buildPromise()

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

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:77

पैरामीटर

methodName

string

controller

object | Controller

validatedArgs

unknown[]

रिटर्न

Promise<unknown>

---

getBodyProperty()

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

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:62

पैरामीटर

body

unknown

headers

Record<string, unknown>

propertyName

string

रिटर्न

unknown

---

getValidatedArgs()

abstract getValidatedArgs(params): unknown[];

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:23

अनुरोध से निकाले गए मार्ग तर्कों को मान्य और सामान्यीकृत करता है।

पैरामीटर

params

ValidationArgsParameters

रिटर्न

unknown[]

---

isController()

protected isController(object): object is Controller;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:28

पैरामीटर

object

object | Controller

रिटर्न

object is Controller

---

isRecord()

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

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:73

पैरामीटर

value

unknown

रिटर्न

value is Record<string, unknown>

---

normalizeRequestBody()

protected normalizeRequestBody(body, headers): unknown;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:54

पैरामीटर

body

unknown

headers

Record<string, unknown>

रिटर्न

unknown

---

requestHasBody()

protected requestHasBody(headers): boolean;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:32

पैरामीटर

headers

Record<string, unknown>

रिटर्न

boolean

---

requestUsesTransferEncoding()

protected requestUsesTransferEncoding(headers): boolean;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:50

पैरामीटर

headers

Record<string, unknown>

रिटर्न

boolean

---

returnHandler()

abstract protected returnHandler(params): unknown;

में परिभाषित: packages/runtime/src/routeGeneration/templates/templateService.ts:26

नियंत्रक को सक्रिय रनटाइम का परिणाम देता है।

पैरामीटर

params

ReturnHandlerParameters

रिटर्न

unknown

Contributors

No contributors

Changelog

No recent changes