tsoa-next
Preparing search index...
tsoa-next
Response
Function Response
Response
<
ExampleType
,
HeaderType
extends
|
object
|
"Header names must be of type string"
|
"Header values must be string or string[]"
=
object
,
>
(
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
,
description
?:
string
,
example
?:
ExampleType
,
produces
?:
string
|
string
[]
,
)
:
MethodDecorator
&
ClassDecorator
Type Parameters
ExampleType
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
Optional
description
:
string
Optional
example
:
ExampleType
Optional
produces
:
string
|
string
[]
Returns
MethodDecorator
&
ClassDecorator
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
tsoa-next
Loading...