@gasket/plugin-express v6.46.8
@gasket/plugin-express
Adds Express to your application.
Guides
- Setup Guide for adding middleware and routes.
- Common "Gotchas" encountered with Express middleware.
Installation
New apps
gasket create <app-name> --plugins @gasket/plugin-express
Existing apps
npm i @gasket/plugin-express
Modify plugins
section of your gasket.config.js
:
module.exports = {
plugins: [
add: [
+ '@gasket/plugin-express'
]
]
}
Configuration
All the configurations for the plugin are added under express
in the config:
compression
: true by default. Can to set to false if applying compression differently.excludedRoutesRegex
: Regex of the routes to exclude by Express.
Example configuration
module.exports = {
plugins: {
add: ['@gasket/express']
},
express: {
compression: false,
excludedRoutesRegex: /^(?!\/_next\/)/
}
}
Lifecycles
middleware
Executed when the express
server has been created, it will apply all returned
functions as middleware.
module.exports = {
hooks: {
/**
* Add Express middleware
*
* @param {Gasket} gasket The Gasket API
* @param {Express} app - Express app instance
* @returns {function|function[]} middleware(s)
*/
middleware: function (gasket, app) {
return require('x-xss-protection')();
}
}
}
You may also return an Array
to inject more than one middleware.
express
Executed after the middleware
event for when you need full control over
the express
instance.
module.exports = {
hooks: {
/**
* Update Express app instance
*
* @param {Gasket} gasket The Gasket API
* @param {Express} express Express app instance
* @returns {function|function[]} middleware(s)
*/
express: async function (gasket, express) {
}
}
}
errorMiddleware
Executed after the express
event. All middleware functions returned from this
hook will be applied to Express.
module.exports = {
hooks: {
/**
* Add Express error middlewares
*
* @param {Gasket} gasket The Gasket API
* @returns {function|function[]} error middleware(s)
*/
errorMiddleware: function (gasket) {
}
}
}
How it works
This plugins hooks the createServers lifecycles from @gasket/plugin-https.
License
4 days ago
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
10 days ago
11 days ago
12 days ago
16 days ago
23 days ago
24 days ago
24 days ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
4 months ago
5 months ago
5 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
11 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago