tsoa-next
Preparing search index...
@tsoa-next/cli
DefaultRouteGenerator
Class DefaultRouteGenerator
Hierarchy (
View Summary
)
AbstractRouteGenerator
<
ExtendedRoutesConfig
>
DefaultRouteGenerator
Index
Constructors
constructor
Properties
metadata
options
path
Transformer
Fn
template
Methods
build
Content
build
Context
build
Models
build
Parameter
Schema
build
Property
build
Property
Schema
Generate
Custom
Routes
Generate
Routes
get
Relative
Import
Path
path
Transformer
should
Write
File
Constructors
constructor
new
DefaultRouteGenerator
(
metadata
:
Metadata
,
options
:
ExtendedRoutesConfig
,
)
:
DefaultRouteGenerator
Parameters
metadata
:
Metadata
options
:
ExtendedRoutesConfig
Returns
DefaultRouteGenerator
Properties
Protected
Readonly
metadata
metadata
:
Metadata
Protected
Readonly
options
options
:
ExtendedRoutesConfig
path
Transformer
Fn
pathTransformerFn
:
(
path
:
string
)
=>
string
template
template
:
string
Methods
build
Content
buildContent
(
middlewareTemplate
:
string
)
:
string
Parameters
middlewareTemplate
:
string
Returns
string
Protected
build
Context
buildContext
()
:
{
authenticationModule
:
string
|
undefined
;
basePath
:
string
;
canImportByAlias
:
boolean
;
controllers
:
{
actions
:
{
fullPath
:
string
;
method
:
string
;
name
:
string
;
parameters
:
{
[
name
:
string
]:
ParameterSchema
}
;
path
:
string
;
security
:
Security
[]
;
successStatus
:
string
|
number
;
uploadFile
:
boolean
;
uploadFileName
:
{
maxCount
:
number
|
undefined
;
multiple
:
boolean
;
name
:
string
;
}
[]
;
}
[]
;
modulePath
:
string
;
name
:
string
;
path
:
string
;
}
[]
;
environment
:
ProcessEnv
;
esm
:
boolean
|
undefined
;
iocModule
:
string
|
undefined
;
minimalSwaggerConfig
:
{
bodyCoercion
:
boolean
;
noImplicitAdditionalProperties
:
|
"ignore"
|
"throw-on-extras"
|
"silently-remove-extras"
;
}
;
models
:
Models
;
multerOpts
:
Options
|
undefined
;
useFileUploads
:
boolean
;
useSecurity
:
boolean
;
}
Returns
{
authenticationModule
:
string
|
undefined
;
basePath
:
string
;
canImportByAlias
:
boolean
;
controllers
:
{
actions
:
{
fullPath
:
string
;
method
:
string
;
name
:
string
;
parameters
:
{
[
name
:
string
]:
ParameterSchema
}
;
path
:
string
;
security
:
Security
[]
;
successStatus
:
string
|
number
;
uploadFile
:
boolean
;
uploadFileName
:
{
maxCount
:
number
|
undefined
;
multiple
:
boolean
;
name
:
string
;
}
[]
;
}
[]
;
modulePath
:
string
;
name
:
string
;
path
:
string
;
}
[]
;
environment
:
ProcessEnv
;
esm
:
boolean
|
undefined
;
iocModule
:
string
|
undefined
;
minimalSwaggerConfig
:
{
bodyCoercion
:
boolean
;
noImplicitAdditionalProperties
:
|
"ignore"
|
"throw-on-extras"
|
"silently-remove-extras"
;
}
;
models
:
Models
;
multerOpts
:
Options
|
undefined
;
useFileUploads
:
boolean
;
useSecurity
:
boolean
;
}
build
Models
buildModels
()
:
Models
Returns
Models
Protected
build
Parameter
Schema
buildParameterSchema
(
source
:
Parameter
)
:
ParameterSchema
Parameters
source
:
Parameter
Returns
ParameterSchema
Protected
build
Property
buildProperty
(
type
:
Type
)
:
PropertySchema
Parameters
type
:
Type
Returns
PropertySchema
Protected
build
Property
Schema
buildPropertySchema
(
source
:
Property
)
:
PropertySchema
Parameters
source
:
Property
Returns
PropertySchema
Generate
Custom
Routes
GenerateCustomRoutes
()
:
Promise
<
void
>
This is the entrypoint for a generator to create a custom set of routes
Returns
Promise
<
void
>
Generate
Routes
GenerateRoutes
(
middlewareTemplate
:
string
)
:
Promise
<
void
>
Parameters
middlewareTemplate
:
string
Returns
Promise
<
void
>
Protected
get
Relative
Import
Path
getRelativeImportPath
(
fileLocation
:
string
)
:
string
Parameters
fileLocation
:
string
Returns
string
Protected
path
Transformer
pathTransformer
(
path
:
string
)
:
string
Parameters
path
:
string
Returns
string
Protected
should
Write
File
shouldWriteFile
(
fileName
:
string
,
content
:
string
)
:
Promise
<
boolean
>
Parameters
fileName
:
string
content
:
string
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
metadata
options
path
Transformer
Fn
template
Methods
build
Content
build
Context
build
Models
build
Parameter
Schema
build
Property
build
Property
Schema
Generate
Custom
Routes
Generate
Routes
get
Relative
Import
Path
path
Transformer
should
Write
File
tsoa-next
Loading...
This is the entrypoint for a generator to create a custom set of routes