# mongoose-sanitize

> Mongoose Sanitizer Plugin

Latest version **1.5.0** (published 2024-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install mongoose-sanitize
pnpm add mongoose-sanitize
yarn add mongoose-sanitize
bun add mongoose-sanitize
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2024-08-23 |
| First published | 2019-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Abhishek Singh |
| Maintainers | abhi11210646 |
| Keywords | xss, sanitizer |

## Links

- npm: https://www.npmjs.com/package/mongoose-sanitize
- Repository: https://github.com/abhi11210646/mongoose-sanitize
- Issues: https://github.com/abhi11210646/mongoose-sanitize/issues
- npm.io page: https://npm.io/package/mongoose-sanitize

## Dependencies (2)

- [traverse](https://npm.io/package/traverse.md) ^0.6.9
- [sanitizer](https://npm.io/package/sanitizer.md) 0.1.3

## Recent versions

- 1.5.0 (latest) — 2024-08-23
- 1.2.0 — 2024-03-03
- 1.1.0 — 2020-09-01
- 1.0.1 — 2019-05-15
- 1.0.0 — 2019-05-15

## README

## Usage

```javascript
const sanitizer = require('mongoose-sanitize');

mongooseSchema.plugin(sanitizer, options);  // `options` optional field

```

### Options

```
let options = { skip:[], include:[] }
```
 - **Skip** Array indicating which fields should be excluded from being sanitized. If omitted or empty, every field in the document will be sanitized.
 - **Include** Array indicating which fields should be included to be sanitized. If omitted or empty, every field in the document will be sanitized.

---
_Source: https://npm.io/package/mongoose-sanitize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._