https://github.com/joelcolucci/express-sanitize-middleware
Sanitize Express request body, query, param, headers
https://github.com/joelcolucci/express-sanitize-middleware
express-middleware expressjs sanitization sanitizer
Last synced: 12 days ago
JSON representation
Sanitize Express request body, query, param, headers
- Host: GitHub
- URL: https://github.com/joelcolucci/express-sanitize-middleware
- Owner: joelcolucci
- License: mit
- Created: 2018-04-06T12:31:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-21T12:05:08.000Z (over 6 years ago)
- Last Synced: 2025-03-18T00:11:39.005Z (about 1 month ago)
- Topics: express-middleware, expressjs, sanitization, sanitizer
- Language: JavaScript
- Size: 4.88 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-sanitize-middleware [](https://www.npmjs.com/package/express-sanitize-middleware)
Sanitize Express request body, query, param, and headers.
Heads up!
This package wraps [MapBox's port of Google's Caja sanitizer](https://github.com/mapbox/sanitize-caja).
Please see the aforementioned repository for details on the actual sanitization functionality.
## Installation
```
# Via NPM
npm install express-sanitize-middleware --save
# Via Yarn
yarn add express-sanitize-middleware
```
## Getting Started
express-sanitize-middleware exposes one function `sanitizeRequest`.
It can be used anywhere Express middleware can.
### Example: sanitize request `body`
```javascript
const express = require('express');
const sanitizeRequest = require('../middleware/express-sanitize-middleware');
const router = express.Router();
router.post('/', [
sanitizeRequest({
body: true
}),
], (req, res, next) => {
return res.json({message: 'Request body sanitized!'});
});
```
## API Reference
### sanitizeRequest(options)
The options argument is required and should contain at least one key dictacting what request property to sanitize.
| Option key | Default |
| -------- | ----------- |
| body | false |
| header | false |
| params | false |
| query | false |
## License
MIT License Copyright (c) 2018 Joel Colucci