node-gdb
Version:
Control GDB from node.js
288 lines (284 loc) • 5.81 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Node-gdb'>
Node-gdb
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>BreakpointManager</span>
</div>
</div>
<div id='content'>
<h1>
Class:
BreakpointManager
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/breaks.coffee</td>
</tr>
</table>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#observe-dynamic'>
#
(Disposable)
<b>observe</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
Invoke the given callback function with all current and future breakpoints in the target.
</span>
</li>
<li>
<span class='signature'>
<a href='#insert-dynamic'>
#
(Promise)
<b>insert</b><span>(location, options)</span>
</a>
</span>
<span class='desc'>
Insert a new breakpoint at the given position.
</span>
</li>
<li>
<span class='signature'>
<a href='#insertWatch-dynamic'>
#
(void)
<b>insertWatch</b><span>(expr, hook)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#toggle-dynamic'>
#
(void)
<b>toggle</b><span>(file, line)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#destroy-dynamic'>
#
(void)
<b>destroy</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='observe-dynamic'>
#
(Disposable)
<b>observe</b><span>(cb)</span>
<br>
</p>
<div class='docstring'>
<p>Invoke the given callback function with all current and future
breakpoints in the target.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Disposable</tt>
)
—
<span class='desc'>to unsubscribe. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='insert-dynamic'>
#
(Promise)
<b>insert</b><span>(location, options)</span>
<br>
</p>
<div class='docstring'>
<p>Insert a new breakpoint at the given position.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>location</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>Name of function or file:line. </span>
</li>
<li>
<span class='name'>options</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
—
<span class='desc'>Breakpoint options </span>
</li>
</ul>
<h3>
Options Hash:
(options):
</h3>
<ul class='options'>
<li>
<span class='name'>temp</span>
<span class='type'>
(
<tt>Boolean</tt>
)
</span>
—
<span class='desc'>Create a temporary breakpoint. </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves to the new <a href='../class/Breakpoint.html'>Breakpoint</a> </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='insertWatch-dynamic'>
#
(void)
<b>insertWatch</b><span>(expr, hook)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='toggle-dynamic'>
#
(void)
<b>toggle</b><span>(file, line)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='destroy-dynamic'>
#
(void)
<b>destroy</b><span>()</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>