log-suspend

log-suspend

🧙‍ A little tool that suspend console.xxx output. Ideal for keeping tests output clean.

💡 why need this.

Like other globals, console is a property of the Window object. We can reference it using Window.console but it's usually shortened to console:

console.log('lalalalala.')

Logging like this is useful for development when we're creating a feature or debugging an issue.

It's not recommended to keep when deploying to production though. Why? Any site visitor would be able to view the messages if they took a peek at their browser console.

In particular, when we use mocha or tap to test the code, we want the console to only output analysis of mocha or tap tests. And for the function to be able to suspend the console, it is like ban the player in the football game.

🤖 Install

# use npm
npm install log-suspend --save(-dev)

# use yarn
yarn add (-D) log-suspend

More suitable for test, so use -D.

⚒ Usage

Maybe you can see more usage from the test case.

logSuspend(console, env, attr)

logSuspend disables the use of the console attribute.

logSuspend takes the current console and optional environment.

Parameters

• console. window.console or global.console.
• env. use in "test | dev".
• attr. console attribute, like log | error | ....

use.

logSus.logSuspend(console,'test', 'error')
logSus.logSuspend(console,'dev', 'log')
logSus.logSuspend(console,'prod', 'all')

logResume

You changed the console, and sometimes you need to restore the console.

use.

logSus.logSuspend(console,'test', 'log')
console.log(111) // can not console
logSus.logResume()
console.log(111) // can console

notConsoleStatus(console, env, attr = 'log', func)

In the test | dev environment, ensure log for other functions, log control for a function.

Parameters

• console. window.console or global.console.
• env. use in "test | dev".
• attr. console attribute, like log | error | ....
• func. the function that suspend the console.

use.

function hasConsole() {
    console.log('test')
    return 'test'
}
console.log('1. can console.log')
let res = logSus.notConsoleStatus(console, 'test', 'log', hasConsole)
console.log('2. can console.log')

🌱 Test

Run the bash tests.

yarn test

🔰 MIT

MIT