tsoa-next / tsoa-next / Response

Function: Response()

function Response<ExampleType, HeaderType>(
   name, 
   description?, 
   example?, 
   produces?): MethodDecorator & ClassDecorator;

Defined in: packages/runtime/src/decorators/response.ts:24

Adds a documented response that can be attached to a method or a controller.

Type Parameters

ExampleType

ExampleType

HeaderType

HeaderType extends | object | "Header names must be of type string" | "Header values must be string or string[]" = object

Parameters

name

| "400" | "401" | "402" | "403" | "404" | "405" | "406" | "407" | "408" | "409" | "410" | "411" | "412" | "413" | "414" | "415" | "416" | "417" | "418" | "422" | "423" | "424" | "425" | "426" | "428" | "429" | "431" | "451" | "500" | "501" | "502" | "503" | "504" | "505" | "506" | "507" | "508" | "510" | "511" | HttpStatusCodeLiteral | "100" | "200" | "101" | "102" | "201" | "202" | "203" | "204" | "205" | "206" | "207" | "208" | "226" | "300" | "301" | "302" | "303" | "304" | "305" | "307" | "308" | OtherValidOpenApiHttpStatusCode

The HTTP status code, OpenAPI response range, or default.

description?

string

The response description shown in the generated OpenAPI document.

example?

ExampleType

An example payload for the response schema.

produces?

string | string[]

The response media type or media types.

Returns

MethodDecorator & ClassDecorator