8888888b. 888 888
888 "Y88b 888 888
888 888 888 888
888 888 .d88b. 88888b. 888 888 .d88b. .d88b. .d88b. .d88888
888 888 d8P Y8b 888 "88b 888 888 d88P"88b d88P"88b d8P Y8b d88" 888
888 888 88888888 888 888 888 888 888 888 888 888 88888888 888 888
888 .d88P Y8b. 888 d88P Y88b 888 Y88b 888 Y88b 888 Y8b. Y88b 888
8888888P" "Y8888 88888P" "Y88888 "Y88888 "Y88888 "Y8888 "Y88888
888 888
Y8b d88P Y8b d88P
"Y88P" "Y88P"
Debugged is a lightweight wrapper for the debug module.
Install using npm
:
$ npm install --save debugged
You'll need to have at least Node.js 4 or newer and debug@^2
is required as a peer dependency.
The API is really just a wrapper around the debug module that follows an Object-oriented Programming (OOP) pattern. The main purpose of it is not really for the API design, but for a shared bucket of debug instances per namespace whose enabled status is automatically refreshed.
The only real difference is how you create debug instances and how you log messages:
const Debugged = require('debugged');
const debug = Debugged.create('app');
debug === Debugged.create('app');
//=> true
debug === Debugged.create('app:example');
//=> false
debug.log('Started %d', process.uptime());
debug.enabled;
//=> false
Debugged.enable('app');
debug.enabled;
//=> true
Debugged.disable();
debug.enabled;
//=> false
If you have any problems with Debugged or would like to see changes currently in development you can do so here.
If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!
A list of Debugged contributors can be found in AUTHORS.md.
See LICENSE.md for more information on our MIT license.