Class: ApplicationMiddleware
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:14
Constructors
Constructor
new ApplicationMiddleware():
ApplicationMiddleware
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:23
Returns
ApplicationMiddleware
Methods
getApplicationMiddleware()
getApplicationMiddleware():
object
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:102
Function
Returns
object
handler
handler:
RequestHandler
middleware
middleware:
undefined|string
runsOnAllRoutes
runsOnAllRoutes:
boolean
Name
getApplicationMiddleware()
Description
Gets the Middleware's Details.
runOnAllRoutes()
runOnAllRoutes(
active:boolean):this
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:91
Function
Parameters
| Parameter | Type | Description |
|---|---|---|
active | boolean |
Returns
this
Name
runOnAllRoutes()
Description
Determine if this middleware is a globally running middleware across your application, or local to any route that specifically uses it.
Default
false // Updates to true if setMiddlewareName is unset.
Example
this.runOnAllRoutes(false)
@function
setHandler()
setHandler(
handler:RequestHandler):this
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:75
Function
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | RequestHandler |
Returns
this
Name
setHandler()
Description
Set the callback function for your middleware.
Default
// Blank Handler
Example
this.setHandler(this.run)
@function
setMiddlewareName()
setMiddlewareName(
name:undefined|string):this
Defined in: src/types/registry/Middlewares/AppMiddlewareType.ts:59
Function
Parameters
| Parameter | Type | Description |
|---|---|---|
name | undefined | string |
Returns
this
Name
setMiddlewareName()
Description
Set the name of your middleware, this is used to enable the middleware in certain routes.
Default
undefined // If no name is set or is set to "", runsOnAllRoutes will default to true and make it a global middleware.
Example
this.setMiddlewareName('authorisationMiddleware')
@function