2.0.0 • Published 5 years ago

hide-secrets v2.0.0

Weekly downloads
730
License
ISC
Repository
github
Last release
5 years ago

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