Skip to content

nunofgs/mask-xml

Repository files navigation

mask-xml

Redacts values in xml. Useful when sending data to external logging services such as Sentry.

Status

npm version npm downloads build status

Installation

Install the package via npm:

$ npm install mask-xml

Usage

Arguments

  1. collection (Array): An array of keys to redact.
  2. [options] (Object): An optional object with the following options:
Option Default value Description
ignoreCase false Whether to ignore case sensitivity when matching keys
replacement --REDACTED-- The default value to replace

Returns

(Function): Returns a function that will redact values from a given xml string.

Example

var blacklist = ['password', 'username'];
var maskXml = require('mask-xml')(blacklist);

maskXml(`<xml><password>foo</password><username>bar</username></xml>`);

// => '<xml><password>--REDACTED--</password><username>--REDACTED--</username></xml>'

Tests

$ npm test

Release

npm version [<new version> | major | minor | patch] -m "Release %s"

License

MIT