Preparing search index...
The search index is not available
tsoa
tsoa
tsoa
Tsoa
ResParameter
Interface ResParameter
interface
ResParameter
{
default
?:
unknown
;
deprecated
:
boolean
;
description
:
string
;
example
?:
{
[
exampleName
:
string
]
:
Swagger
.
Example3
;
}
[]
;
exampleLabels
?:
(
undefined
|
string
)
[]
;
examples
?:
{
[
exampleName
:
string
]
:
Swagger
.
Example3
;
}
[]
;
headers
?:
Tsoa
.
HeaderType
;
in
:
"res"
;
name
:
string
;
parameterName
:
string
;
produces
?:
string
[]
;
required
?:
boolean
;
schema
?:
Tsoa
.
Type
;
type
:
Tsoa
.
Type
;
validators
:
Partial
<
Record
<
Tsoa
.
ValidatorKey
,
{
errorMsg
?:
string
;
value
?:
unknown
;
}
>
>
;
}
Hierarchy (
view full
)
Tsoa
.
Response
Tsoa
.
Parameter
ResParameter
Index
Properties
default?
deprecated
description
example?
example
Labels?
examples?
headers?
in
name
parameter
Name
produces?
required?
schema?
type
validators
Properties
Optional
default
default
?:
unknown
deprecated
deprecated
:
boolean
description
description
:
string
Optional
example
example
?:
{
[
exampleName
:
string
]
:
Swagger
.
Example3
;
}
[]
Type declaration
[
exampleName
:
string
]:
Swagger
.
Example3
Optional
example
Labels
example
Labels
?:
(
undefined
|
string
)
[]
Optional
examples
examples
?:
{
[
exampleName
:
string
]
:
Swagger
.
Example3
;
}
[]
Type declaration
[
exampleName
:
string
]:
Swagger
.
Example3
Optional
headers
headers
?:
Tsoa
.
HeaderType
in
in
:
"res"
name
name
:
string
parameter
Name
parameter
Name
:
string
Optional
produces
produces
?:
string
[]
Optional
required
required
?:
boolean
Optional
schema
schema
?:
Tsoa
.
Type
type
type
:
Tsoa
.
Type
validators
validators
:
Partial
<
Record
<
Tsoa
.
ValidatorKey
,
{
errorMsg
?:
string
;
value
?:
unknown
;
}
>
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
default
deprecated
description
example
example
Labels
examples
headers
in
name
parameter
Name
produces
required
schema
type
validators
tsoa
@tsoa
cli
AbstractRouteGenerator
DefaultRouteGenerator
Config
ConfigArgs
ExtendedRoutesConfig
ExtendedSpecConfig
SwaggerArgs
generateRoutes
generateSpec
generateSpecAndRoutes
getSwaggerOutputPath
runCLI
validateSpecConfig
runtime
Swagger
ApiKeySecurity
BaseParameter
BaseSchema
BasicSecurity
BasicSecurity3
BearerSecurity3
BodyParameter
Components
Contact
Example3
ExternalDocs
FormDataParameter
Header
Header3
HeaderParameter
Info
License
MediaType
OAuth2AccessCodeSecurity
OAuth2ApplicationSecurity
OAuth2ImplicitSecurity
OAuth2PasswordSecurity
OAuth2Security3
OAuth2SecurityFlow3
OAuthScope
OpenIDSecurity
Operation
Operation3
Path
Path3
PathParameter
QueryParameter
RequestBody
Response
Response3
Schema
Schema2
Schema3
Security
Server
Spec
Spec2
Spec3
Tag
XML
DataFormat
DataType
OAuth2FlowTypes
OAuthFlow
Parameter
Parameter2
Parameter3
Protocol
SecuritySchemes
SupportedSpecMajorVersion
isQueryParameter
Tsoa
AnyType
ArrayParameter
ArrayType
BinaryType
BooleanType
BufferType
ByteType
Controller
DateTimeType
DateType
DoubleType
EnumType
Extension
FileType
FloatType
IntegerType
IntersectionType
LongType
Metadata
Method
MethodsSignatureMap
NestedObjectLiteralType
ObjectsNoPropsType
Parameter
Property
RefAliasType
RefEnumType
RefObjectType
ReferenceTypeBase
ReferenceTypeMap
ResParameter
Response
Security
StringType
TypeBase
UndefinedType
UnionType
VoidType
HeaderType
PrimitiveType
PrimitiveTypeLiteral
RefTypeLiteral
ReferenceType
SchemaValidatorKey
Type
TypeStringLiteral
ValidatorKey
Validators
TsoaRoute
Models
ParameterSchema
PropertySchema
RefEnumModelSchema
RefObjectModelSchema
RefObjectModels
RefTypeAliasModelSchema
Security
ModelSchema
ValidatorSchema
Controller
ExpressTemplateService
HapiTemplateService
KoaTemplateService
TemplateService
ValidateError
ValidationService
AdditionalProps
ArrayValidator
BooleanValidator
Config
DateTimeValidator
DateValidator
Exception
FieldErrors
File
FloatValidator
IntegerValidator
IocContainer
RoutesConfig
SpecConfig
StringValidator
DeprecatedOptionForAdditionalPropertiesHandling
ExtensionType
HttpStatusCodeLiteral
HttpStatusCodeStringLiteral
IocContainerFactory
OtherValidOpenApiHttpStatusCode
TsoaResponse
Validator
Body
BodyProp
Consumes
Delete
Deprecated
Example
Extension
FormField
Get
Head
Header
Hidden
Inject
Middlewares
NoSecurity
OperationId
Options
Patch
Path
Post
Produces
Put
Queries
Query
Request
RequestProp
Res
Response
Route
Security
SuccessResponse
Tags
UploadedFile
UploadedFiles
ValidateParam
assertNever
fetchMiddlewares
isDefaultForAdditionalPropertiesAllowed
tsoa
Swagger
ApiKeySecurity
BaseParameter
BaseSchema
BasicSecurity
BasicSecurity3
BearerSecurity3
BodyParameter
Components
Contact
Example3
ExternalDocs
FormDataParameter
Header
Header3
HeaderParameter
Info
License
MediaType
OAuth2AccessCodeSecurity
OAuth2ApplicationSecurity
OAuth2ImplicitSecurity
OAuth2PasswordSecurity
OAuth2Security3
OAuth2SecurityFlow3
OAuthScope
OpenIDSecurity
Operation
Operation3
Path
Path3
PathParameter
QueryParameter
RequestBody
Response
Response3
Schema
Schema2
Schema3
Security
Server
Spec
Spec2
Spec3
Tag
XML
DataFormat
DataType
OAuth2FlowTypes
OAuthFlow
Parameter
Parameter2
Parameter3
Protocol
SecuritySchemes
SupportedSpecMajorVersion
isQueryParameter
Tsoa
AnyType
ArrayParameter
ArrayType
BinaryType
BooleanType
BufferType
ByteType
Controller
DateTimeType
DateType
DoubleType
EnumType
Extension
FileType
FloatType
IntegerType
IntersectionType
LongType
Metadata
Method
MethodsSignatureMap
NestedObjectLiteralType
ObjectsNoPropsType
Parameter
Property
RefAliasType
RefEnumType
RefObjectType
ReferenceTypeBase
ReferenceTypeMap
ResParameter
Response
Security
StringType
TypeBase
UndefinedType
UnionType
VoidType
HeaderType
PrimitiveType
PrimitiveTypeLiteral
RefTypeLiteral
ReferenceType
SchemaValidatorKey
Type
TypeStringLiteral
ValidatorKey
Validators
TsoaRoute
Models
ParameterSchema
PropertySchema
RefEnumModelSchema
RefObjectModelSchema
RefObjectModels
RefTypeAliasModelSchema
Security
ModelSchema
ValidatorSchema
AbstractRouteGenerator
Controller
DefaultRouteGenerator
ExpressTemplateService
HapiTemplateService
KoaTemplateService
TemplateService
ValidateError
ValidationService
AdditionalProps
ArrayValidator
BooleanValidator
Config
ConfigArgs
DateTimeValidator
DateValidator
Exception
ExtendedRoutesConfig
ExtendedSpecConfig
FieldErrors
File
FloatValidator
IntegerValidator
IocContainer
RoutesConfig
SpecConfig
StringValidator
SwaggerArgs
DeprecatedOptionForAdditionalPropertiesHandling
ExtensionType
HttpStatusCodeLiteral
HttpStatusCodeStringLiteral
IocContainerFactory
OtherValidOpenApiHttpStatusCode
TsoaResponse
Validator
Body
BodyProp
Consumes
Delete
Deprecated
Example
Extension
FormField
Get
Head
Header
Hidden
Inject
Middlewares
NoSecurity
OperationId
Options
Patch
Path
Post
Produces
Put
Queries
Query
Request
RequestProp
Res
Response
Route
Security
SuccessResponse
Tags
UploadedFile
UploadedFiles
ValidateParam
assertNever
fetchMiddlewares
generateRoutes
generateSpec
generateSpecAndRoutes
getSwaggerOutputPath
isDefaultForAdditionalPropertiesAllowed
runCLI
validateSpecConfig
Generated using
TypeDoc