debug-fabulous
TypeScript icon, indicating that this package has built-in type declarations

2.0.2 • Public • Published

debug-fabulous NPM version build status Test coverage

Install

npm install --save debug-fabulous

Purpose:

Wrapper / Extension around visionmedia's debug to allow lazy evaluation of debugging via closure handling.

Why would I consider using this library?

The main utilities added to this library is lazy log level evaluation. This allows whatever logged strings to only be created and evaluated if a log level is active. This can considerably reduce the amount of memory used in logging when you are not using.

With this in mind, there are no excuses to not log anything and everything as performance can be kept in check easily (via log levels).

Proof

For analysis of the performance results are in perfWith.out and perfWithout.out.

In summary, the tests using this library are using 3 times less memory for the same logging statements (when the log levels are disabled).

This library essentially wraps two things:

  • lazy-eval: debug closure handling
  • spawn: spawns off existing namespaces for a sub namespace.

Example:

For usage see the tests or the example below.

var debug = require('')();
// force namespace to be enabled otherwise it assumes process.env.DEBUG is setup
// debug.save('namespace');
// debug.enable(debug.load())
debug = debug('namespace'); // debugger in the namespace
debug(function() {
  return 'something to log' + someLargeHarryString;
});
debug(() => 'something to log ${someLargeHarryString}');
debug('small out'); // prints namespace small out
var childDbg = debug.spawn('child'); // debugger in the namespace:child
childDbg('small out'); // prints namespace:child small out
var grandChildDbg = debug.spawn('grandChild'); // debugger in the namespace:child:grandChild
grandChildDbg('small out'); // prints namespace:child:grandChild small out

Readme

Keywords

Package Sidebar

Install

npm i debug-fabulous

Weekly Downloads

439,759

Version

2.0.2

License

MIT

Unpacked Size

77 kB

Total Files

14

Last publish

Collaborators

  • nmccready