hide-secrets

2.0.0 • Public • Published

hide-secrets

Build Status Coverage Status NPM version js-standard-style

var hide = require('hide-secrets')
 
var obj = {
  innerObject: {
    password: 'abc123',
    email: 'ben@npmjs.com',
    token: 'my-secret-token'
  },
  auth: '' // empty strings are left empty.
}
 
console.log(hide(obj))

outputs

{
  innerObject: {
    password: '[SECRET]',
    email: 'ben@npmjs.com',
    token: '[SECRET]'
  },
  auth: ''
}

Currently the following fields are obfuscated by default:

password, pass, token, auth, secret, passphrase.

If you want to override this list of obfuscated terms, simply:

  1. create your own list of terms:

    const badWords = [
      'super-secret-1', 'double-secret-probation'
    ]
  2. pass this as configuration to hide-secrets:

    console.log(hide(obj, {badWords}))

Any keys within obj that are contained within the badWords array will be hidden.

License

ISC

Dependencies (1)

Dev Dependencies (4)

Package Sidebar

Install

npm i hide-secrets

Weekly Downloads

2,828

Version

2.0.0

License

ISC

Unpacked Size

6.78 kB

Total Files

7

Last publish

Collaborators

  • bcoe