tsoa-next / @tsoa-next/runtime / Controller

Class: Controller

Defined in: packages/runtime/src/interfaces/controller.ts:9

Base controller class that lets actions override the eventual status code and headers.

Constructors

Constructor

new Controller(): Controller;

Returns

Controller

Methods

getHeader()

getHeader(name): string | string[] | undefined;

Defined in: packages/runtime/src/interfaces/controller.ts:32

Returns a previously assigned response header value.

Parameters

name

string

Returns

string | string[] | undefined

---

getHeaders()

getHeaders(): object;

Defined in: packages/runtime/src/interfaces/controller.ts:37

Returns all response headers assigned on the controller instance.

Returns

object

---

getStatus()

getStatus(): number | undefined;

Defined in: packages/runtime/src/interfaces/controller.ts:19

Returns the HTTP status code set through setStatus, if any.

Returns

number | undefined

---

setHeader()

Stores a response header value that the generated route handler should emit.

Call Signature

setHeader<H>(name, value?): void;

Defined in: packages/runtime/src/interfaces/controller.ts:23

Type Parameters

H

H extends keyof OutgoingHttpHeaders

Parameters

name

H

value?

HeaderValue<H>

Returns

void

Call Signature

setHeader(name, value?): void;

Defined in: packages/runtime/src/interfaces/controller.ts:24

Parameters

name

string

value?

string | string[]

Returns

void

---

setStatus()

setStatus(statusCode): void;

Defined in: packages/runtime/src/interfaces/controller.ts:14

Sets the HTTP status code that the generated route handler should return.

Parameters

statusCode

number

Returns

void