Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.21 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.21 KB

mongodb-redact

Remove potentially sensitive information from objects without changing the shape.

Inspired by fruitsalad and mongo-redact.

Installation

npm install --save mongodb-redact

API

var redact = require('mongodb-redact');

// `variable` can be of any type, including object and array.
var result = redact(variable);

Redaction

The following types of strings are currently redacted:

  • Certificates and private keys
  • Electron application resource directories (Windows, OS X, Linux)
  • Generic user directories (Windows, OS X, Linux)
  • Email addresses
  • IP addresses
  • URLs
  • MongoDB connection strings

Does not redact any non-string types (e.g. numbers, dates, etc).

For examples, see ./test/index.test.js.

License

Apache 2.0