mongoose-sanitizer
v1.0.0
Published
Mongoose Sanitizer Plugin
Downloads
215
Readme
About
Simple plugin for Mongoose that sainitizes document fields before saving them. Makes use of Google Caja's HTML Sanitizer to perform the sanitization.
Installation
npm install --save mongoose-sanitizer
Usage
var sanitizerPlugin = require('mongoose-sanitizer');
MyMongooseSchema.plugin(sanitizerPlugin);
When saving a document generated with MyMongooseSchema, mongoose-sanitizer will automatically iterate over every field, sanitizing them before storage in the database.
An optional options object can be passed with the following attributes:
skip
- Default is
[]
- Array indicating which fields should be excluded from being sanitized. If omitted or empty, every field in the document will be sanitized.
- Default is
include
- Default is
[]
- Array indicating which fields should be sanitized. If omitted or empty, every field in the document will be sanitized.
- Default is
License
(The MIT License)
Copyright (c) 2013 Fer Uría <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.