npm.io
1.0.5 • Published 7 years ago

redakt

Licence
MIT
Version
1.0.5
Deps
0
Size
15 kB
Vulns
0
Weekly
0

Redakt Object

Installation

# With Yarn
yarn add redakt

# With NPM 
npm install redakt

Usage

import redakt from 'redakt';

const objWithSecrets = {
  password: 'THISISMYPASSWORD',
};

const redactedObject = redakt(objWithSecrets, {
  enabled: true,
  replace: '[REDACTED]',
  keys: [
    'password',
  ],
});

console.log(redactedObject);
// {
//    password: '[REDACTED]'
// }

Parameters

Element Object or JSON

Redact's first parameter is the object or JSON string that you would like to recursively redact.

Options Object

Redact's second parameter is the options object.

Parameter Type Default Description
enabled Boolean true Enable or disable redaction.
replace String "[REDACTED]" String to replace redacted values.
keys Array [] List of keys to redact