Search
Preparing search index...
The search index is not available
@sheetbase/server
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
RouterService
Class RouterService
Hierarchy
RouterService
Index
Constructors
constructor
Methods
all
delete
extend
get
patch
post
put
register
use
Constructors
constructor
new
Router
Service
(
serverService
:
ServerService
)
:
RouterService
Parameters
serverService:
ServerService
Returns
RouterService
Methods
all
all
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
delete
delete
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
extend
extend
(
configs
:
RouterExtending
, ignoreDisabledRoutes
?:
boolean
)
:
RouterService
Parameters
configs:
RouterExtending
Default value
ignoreDisabledRoutes:
boolean
= false
Returns
RouterService
get
get
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
patch
patch
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
post
post
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
put
put
(
endpoint
:
string
,
...
handlers
:
RoutingHandler
[]
)
:
void
Parameters
endpoint:
string
Rest
...
handlers:
RoutingHandler
[]
Returns
void
register
register
(
items
:
unknown
[]
, routeEnabling
?:
true
|
DisabledRoutes
, customMiddlewares
?:
Middlewares
|
RouteMiddlewares
)
:
this
Parameters
items:
unknown
[]
Optional
routeEnabling:
true
|
DisabledRoutes
Default value
customMiddlewares:
Middlewares
|
RouteMiddlewares
= []
Returns
this
use
use
(
...
handlers
:
Array
<
string
|
RoutingHandler
>
)
:
void
|
RoutingHandler
[]
Parameters
Rest
...
handlers:
Array
<
string
|
RoutingHandler
>
Returns
void
|
RoutingHandler
[]
Globals
APIKey
Middleware
APIKey
Service
Http
Service
Lib
Logging
Route
Monitoring
Service
Option
Service
Response
Service
Router
Service
constructor
all
delete
extend
get
patch
post
put
register
use
Server
Route
Server
Service
Api
Key
Api
Keys
Disabled
Routes
Http
Event
Http
Param
Options
Response
Error
Response
Success
Route
Group
Route
Middlewares
Route
Request
Route
Set
Router
Extending
Routes
Routing
Error
Routing
Errors
Disabled
Route
Value
Http
Method
Logging
Level
Logging
Value
Middlewares
Route
Next
Route
Response
Routing
Handler
Routing
Method
Routing
Result
View
Engine
Handlebars
ejs
Generated using
TypeDoc