Search
Preparing search index...
The search index is not available
@sheetbase/server
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
Lib
Class Lib
Hierarchy
Lib
Index
Constructors
constructor
Properties
api
Key
Middleware
api
Key
Service
http
Service
logging
Route
monitoring
Service
option
Service
response
Service
router
Service
server
Route
server
Service
Methods
register
Routes
useAPIKey
Middleware
Constructors
constructor
new
Lib
(
options
?:
Options
)
:
Lib
Parameters
Default value
options:
Options
= {}
Returns
Lib
Properties
api
Key
Middleware
api
Key
Middleware
:
APIKeyMiddleware
api
Key
Service
api
Key
Service
:
APIKeyService
http
Service
http
Service
:
HttpService
logging
Route
logging
Route
:
LoggingRoute
monitoring
Service
monitoring
Service
:
MonitoringService
option
Service
option
Service
:
OptionService
response
Service
response
Service
:
ResponseService
router
Service
router
Service
:
RouterService
server
Route
server
Route
:
ServerRoute
server
Service
server
Service
:
ServerService
Methods
register
Routes
register
Routes
(
routeEnabling
?:
true
|
DisabledRoutes
, middlewares
?:
Middlewares
|
RouteMiddlewares
)
:
RouterService
Expose the module routes
Parameters
Optional
routeEnabling:
true
|
DisabledRoutes
Optional
middlewares:
Middlewares
|
RouteMiddlewares
Returns
RouterService
useAPIKey
Middleware
useAPIKey
Middleware
(
)
:
RoutingHandler
Get the API key middleware
Returns
RoutingHandler
Globals
APIKey
Middleware
APIKey
Service
Http
Service
Lib
constructor
api
Key
Middleware
api
Key
Service
http
Service
logging
Route
monitoring
Service
option
Service
response
Service
router
Service
server
Route
server
Service
register
Routes
useAPIKey
Middleware
Logging
Route
Monitoring
Service
Option
Service
Response
Service
Router
Service
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
Expose the module routes