Skip to content

Commit

Permalink
Merge pull request #34 from gjohnson/master
Browse files Browse the repository at this point in the history
clarify usage
  • Loading branch information
tj committed Jan 5, 2013
2 parents 78106cc + 5114094 commit 73936c4
Showing 1 changed file with 3 additions and 18 deletions.
21 changes: 3 additions & 18 deletions Readme.md
@@ -1,32 +1,17 @@

# debug

tiny node.js debugging utility.
tiny node.js debugging utility modelled after node core's debugging technique.

## Installation

```
$ npm install debug
```

## Example
## Usage

This module is modelled after node core's debugging technique, allowing you to enable one or more topic-specific debugging functions, for example core does the following within many modules:

```js
var debug;
if (process.env.NODE_DEBUG && /cluster/.test(process.env.NODE_DEBUG)) {
debug = function(x) {
var prefix = process.pid + ',' +
(process.env.NODE_WORKER_ID ? 'Worker' : 'Master');
console.error(prefix, x);
};
} else {
debug = function() { };
}
```

This concept is extremely simple but it works well. With `debug` you simply invoke the exported function to generate your debug function, passing it a name which will determine if a noop function is returned, or a decorated `console.error`, so all of the `console` format string goodies you're used to work fine. A unique color is selected per-function for visibility.
With `debug` you simply invoke the exported function to generate your debug function, passing it a name which will determine if a noop function is returned, or a decorated `console.error`, so all of the `console` format string goodies you're used to work fine. A unique color is selected per-function for visibility.

Example _app.js_:

Expand Down

0 comments on commit 73936c4

Please sign in to comment.