{ "source": "doc/api/debugger.md", "stability": 2, "stabilityText": "Stable", "properties": [ { "textRaw": "V8 Inspector Integration for Node.js", "name": "js", "desc": "
NOTE: This is an experimental feature.
\nV8 Inspector integration allows attaching Chrome DevTools to Node.js\ninstances for debugging and profiling.
\nV8 Inspector can be enabled by passing the --inspect
flag when starting a\nNode.js application. It is also possible to supply a custom port with that flag,\ne.g. --inspect=9222
will accept DevTools connections on port 9222.
To break on the first line of the application code, provide the --debug-brk
\nflag in addition to --inspect
.
$ node --inspect index.js\nDebugger listening on port 9229.\nWarning: This is an experimental feature and could change at any time.\nTo start debugging, open the following URL in Chrome:\n chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node\n
\n"
}
],
"miscs": [
{
"textRaw": "Debugger",
"name": "Debugger",
"stability": 2,
"stabilityText": "Stable",
"type": "misc",
"desc": "Node.js includes an out-of-process debugging utility accessible via a\nTCP-based protocol and built-in debugging client. To use it, start Node.js\nwith the debug
argument followed by the path to the script to debug; a prompt\nwill be displayed indicating successful launch of the debugger:
$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n 1 x = 5;\n 2 setTimeout(() => {\n 3 debugger;\ndebug>\n
\nNode.js's debugger client is not a full-featured debugger, but simple step and\ninspection are possible.
\nInserting the statement debugger;
into the source code of a script will\nenable a breakpoint at that position in the code:
// myscript.js\nx = 5;\nsetTimeout(() => {\n debugger;\n console.log('world');\n}, 1000);\nconsole.log('hello');\n
\nOnce the debugger is run, a breakpoint will occur at line 4:
\n$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n 1 x = 5;\n 2 setTimeout(() => {\n 3 debugger;\ndebug> cont\n< hello\nbreak in /home/indutny/Code/git/indutny/myscript.js:3\n 1 x = 5;\n 2 setTimeout(() => {\n 3 debugger;\n 4 console.log('world');\n 5 }, 1000);\ndebug> next\nbreak in /home/indutny/Code/git/indutny/myscript.js:4\n 2 setTimeout(() => {\n 3 debugger;\n 4 console.log('world');\n 5 }, 1000);\n 6 console.log('hello');\ndebug> repl\nPress Ctrl + C to leave debug repl\n> x\n5\n> 2+2\n4\ndebug> next\n< world\nbreak in /home/indutny/Code/git/indutny/myscript.js:5\n 3 debugger;\n 4 console.log('world');\n 5 }, 1000);\n 6 console.log('hello');\n 7\ndebug> quit\n
\nThe repl
command allows code to be evaluated remotely. The next
command\nsteps to the next line. Type help
to see what other commands are available.
Pressing enter
without typing a command will repeat the previous debugger\ncommand.
It is possible to watch expression and variable values while debugging. On\nevery breakpoint, each expression from the watchers list will be evaluated\nin the current context and displayed immediately before the breakpoint's\nsource code listing.
\nTo begin watching an expression, type watch('my_expression')
. The command\nwatchers
will print the active watchers. To remove a watcher, type\nunwatch('my_expression')
.
cont
, c
- Continue executionnext
, n
- Step nextstep
, s
- Step inout
, o
- Step outpause
- Pause running code (like pause button in Developer Tools)setBreakpoint()
, sb()
- Set breakpoint on current linesetBreakpoint(line)
, sb(line)
- Set breakpoint on specific linesetBreakpoint('fn()')
, sb(...)
- Set breakpoint on a first statement in\nfunctions bodysetBreakpoint('script.js', 1)
, sb(...)
- Set breakpoint on first line of\nscript.jsclearBreakpoint('script.js', 1)
, cb(...)
- Clear breakpoint in script.js\non line 1It is also possible to set a breakpoint in a file (module) that\nis not loaded yet:
\n$ node debug test/fixtures/break-in-module/main.js\n< debugger listening on port 5858\nconnecting to port 5858... ok\nbreak in test/fixtures/break-in-module/main.js:1\n 1 var mod = require('./mod.js');\n 2 mod.hello();\n 3 mod.hello();\ndebug> setBreakpoint('mod.js', 23)\nWarning: script 'mod.js' was not loaded yet.\n 1 var mod = require('./mod.js');\n 2 mod.hello();\n 3 mod.hello();\ndebug> c\nbreak in test/fixtures/break-in-module/mod.js:23\n 21\n 22 exports.hello = () => {\n 23 return 'hello from module';\n 24 };\n 25\ndebug>\n
\n",
"type": "module",
"displayName": "Breakpoints"
},
{
"textRaw": "Execution control",
"name": "Execution control",
"desc": "run
- Run script (automatically runs on debugger's start)restart
- Restart scriptkill
- Kill scriptscripts
- List all loaded scriptsversion
- Display V8's versionAn alternative way of enabling and accessing the debugger is to start\nNode.js with the --debug
command-line flag or by signaling an existing\nNode.js process with SIGUSR1
.
Once a process has been set in debug mode this way, it can be inspected\nusing the Node.js debugger by either connecting to the pid
of the running\nprocess or via URI reference to the listening debugger:
node debug -p <pid>
- Connects to the process via the pid
node debug <URI>
- Connects to the process via the URI such as\nlocalhost:5858NOTE: This is an experimental feature.
\nV8 Inspector integration allows attaching Chrome DevTools to Node.js\ninstances for debugging and profiling.
\nV8 Inspector can be enabled by passing the --inspect
flag when starting a\nNode.js application. It is also possible to supply a custom port with that flag,\ne.g. --inspect=9222
will accept DevTools connections on port 9222.
To break on the first line of the application code, provide the --debug-brk
\nflag in addition to --inspect
.
$ node --inspect index.js\nDebugger listening on port 9229.\nWarning: This is an experimental feature and could change at any time.\nTo start debugging, open the following URL in Chrome:\n chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node\n
\n"
}
]
}
]
}