tsoa-next / tsoa-next / SpecRequestContext

Interface: SpecRequestContext

Defined in: packages/runtime/src/decorators/specPath.ts:41

Request-scoped context passed to custom SpecPath handlers.

Extends

• SpecCacheContext

Properties

cacheKey

cacheKey: string;

Defined in: packages/runtime/src/decorators/specPath.ts:31

Inherited from

SpecCacheContext.cacheKey

---

controllerClass

controllerClass: object;

Defined in: packages/runtime/src/decorators/specPath.ts:32

Inherited from

SpecCacheContext.controllerClass

---

format?

optional format?: SpecDocumentFormat | "html";

Defined in: packages/runtime/src/decorators/specPath.ts:37

Inherited from

SpecCacheContext.format

---

fullPath

fullPath: string;

Defined in: packages/runtime/src/decorators/specPath.ts:33

Inherited from

SpecCacheContext.fullPath

---

path

path: string;

Defined in: packages/runtime/src/decorators/specPath.ts:34

Inherited from

SpecCacheContext.path

---

request?

optional request?: unknown;

Defined in: packages/runtime/src/decorators/specPath.ts:42

---

response?

optional response?: unknown;

Defined in: packages/runtime/src/decorators/specPath.ts:43

---

runtime

runtime: SpecRuntime;

Defined in: packages/runtime/src/decorators/specPath.ts:35

Inherited from

SpecCacheContext.runtime

---

target

target: 
  | BuiltinSpecPathTarget
  | "custom";

Defined in: packages/runtime/src/decorators/specPath.ts:36

Inherited from

SpecCacheContext.target

Methods

getSpecObject()

getSpecObject(): Promise<Spec>;

Defined in: packages/runtime/src/decorators/specPath.ts:44

Returns

Promise<Spec>

---

getSpecString()

getSpecString(format): Promise<string>;

Defined in: packages/runtime/src/decorators/specPath.ts:45

Parameters

format

SpecDocumentFormat

Returns

Promise<string>