atomicrecord
Version:
Super lightweight node.js ActiveRecord ORM layer for FoundationDB
302 lines (292 loc) • 6.63 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'undefined']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='AtomicRecord'>
AtomicRecord
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>Finder</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Finder
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/finder.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
FDBoost.range.Reader
</td>
</tr>
</table>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#finalize-dynamic'>
#
(void)
<b>finalize</b><span>(err, callback)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#toArray-dynamic'>
#
(void)
<b>toArray</b><span>(iterator, callback)</span>
</a>
</span>
<span class='desc'>
<ul> Iterate over array results
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#forEachBatch-dynamic'>
#
(void)
<b>forEachBatch</b><span>(iterator, callback)</span>
</a>
</span>
<span class='desc'>
<ul> Iterate over batch results
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#forEach-dynamic'>
#
(void)
<b>forEach</b><span>(iterator, callback)</span>
</a>
</span>
<span class='desc'>
<ul> Iterate over key-value pair results
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#execute-dynamic'>
#
(void)
<b>execute</b><span>(tr, iteratorType)</span>
</a>
</span>
<span class='desc'>
<ul> Execute the finder using an iterator type
<li>@override</li>
<li>@param {object} tr Optional transaction.</li>
</ul>
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='finalize-dynamic'>
#
(void)
<b>finalize</b><span>(err, callback)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='toArray-dynamic'>
#
(void)
<b>toArray</b><span>(iterator, callback)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Iterate over array results </li>
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
<li>@param {iterateCallback} callback Callback.</li>
<li>@fires RangeReader#data</li>
<li>@return {undefined}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='forEachBatch-dynamic'>
#
(void)
<b>forEachBatch</b><span>(iterator, callback)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Iterate over batch results </li>
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
<li>@param {iterateCallback} callback Callback.</li>
<li>@fires RangeReader#data</li>
<li>@return {undefined}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='forEach-dynamic'>
#
(void)
<b>forEach</b><span>(iterator, callback)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Iterate over key-value pair results </li>
<li>@override</li>
<li>@param {LazyIterator} iterator LazyIterator instance.</li>
<li>@param {iterateCallback} callback Callback.</li>
<li>@fires RangeReader#data</li>
<li>@return {undefined}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='execute-dynamic'>
#
(void)
<b>execute</b><span>(tr, iteratorType)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Execute the finder using an iterator type </li>
<li>@override</li>
<li>@param {object} tr Optional transaction.</li>
<li>@param {string} iteratorType batch|each|array.</li>
<li>@fires RangeReader#error</li>
<li>@fires RangeReader#continue</li>
<li>@fires RangeReader#end</li>
<li>@return {undefined}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
January 20, 15 12:49:54 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
✲
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>