49 lines
7.3 KiB
JSON
49 lines
7.3 KiB
JSON
|
{
|
||
|
|
"name": "debug",
|
||
|
|
"version": "2.2.0",
|
||
|
|
"repository": {
|
||
|
|
"type": "git",
|
||
|
|
"url": "git://github.com/visionmedia/debug.git"
|
||
|
|
},
|
||
|
|
"description": "small debugging utility",
|
||
|
|
"keywords": [
|
||
|
|
"debug",
|
||
|
|
"log",
|
||
|
|
"debugger"
|
||
|
|
],
|
||
|
|
"author": {
|
||
|
|
"name": "TJ Holowaychuk",
|
||
|
|
"email": "tj@vision-media.ca"
|
||
|
|
},
|
||
|
|
"contributors": [
|
||
|
|
{
|
||
|
|
"name": "Nathan Rajlich",
|
||
|
|
"email": "nathan@tootallnate.net",
|
||
|
|
"url": "http://n8.io"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"license": "MIT",
|
||
|
|
"dependencies": {
|
||
|
|
"ms": "0.7.1"
|
||
|
|
},
|
||
|
|
"devDependencies": {
|
||
|
|
"browserify": "9.0.3",
|
||
|
|
"mocha": "*"
|
||
|
|
},
|
||
|
|
"main": "./node.js",
|
||
|
|
"browser": "./browser.js",
|
||
|
|
"component": {
|
||
|
|
"scripts": {
|
||
|
|
"debug/index.js": "browser.js",
|
||
|
|
"debug/debug.js": "debug.js"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"readme": "# debug\n\n tiny node.js debugging utility modelled after node core's debugging technique.\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n 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.\n\nExample _app.js_:\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %s', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample _worker.js_:\n\n```js\nvar debug = require('debug')('worker');\n\nsetInterval(function(){\n debug('doing some work');\n}, 1000);\n```\n\n The __DEBUG__ environment variable is then used to enable these based on space or comma-delimited names. Here are some examples:\n\n \n\n \n\n#### Windows note\n\n On Windows the environment variable is set using the `set` command.\n\n ```cmd\n set DEBUG=*,-not_this\n ```\n\nThen, run the program to be debugged as usual.\n\n## Millisecond diff\n\n When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n \n\n When stdout is not a TTY, `Date#toUTCString()` is used, making it more useful for logging the debug information as shown below:\n\n \n\n## Conventions\n\n If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\".\n\n## Wildcards\n\n The `*` character may be used as a wildcard. Suppose for example your library has debuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\", instead of listing all three with `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\n You can also exclude specific debuggers by prefixing them with a \"-\" character. For example, `DEBUG=*,-connect:*` would include all debuggers except those starting with \"connect:\".\n\n## Browser support\n\n Debug works in the browser as well, currently persisted by `localStorage`. Consider the situation shown below where you have `worker:a` and `worker:b`, and wish to debug both. Somewhere in the code on your page, include:\n\n```js\nwindow.myDebug = require(\"debug\");\n```\n\n (\"debug\" is a global object in the browser so we give this object a different name.) When your page is open in the browser, type the following in the console:\n\n```js\nmyDebug.enable(\"worker:*\")\n```\n\n Refresh the page. Debug output will continue to be sent to the console until it is disabled by typing `myDebug.disable()` in the console.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n#### Web Inspector Colors\n\n Colors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\n option. These are WebKit web inspectors, Firefox ([since version\n 31](https://hacks.mo
|
||
|
|
"readmeFilename": "Readme.md",
|
||
|
|
"bugs": {
|
||
|
|
"url": "https://github.com/visionmedia/debug/issues"
|
||
|
|
},
|
||
|
|
"_id": "debug@2.2.0",
|
||
|
|
"_from": "debug@~2.2.0"
|
||
|
|
}
|