spahql
Version:
A query language and data model for deep Javascript object structures.
175 lines (126 loc) • 13.5 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>SpahQL v0.7.0 API documentation | SpahQL.DataHelper.jointSetWithCallback</title>
<meta name="generator" content="PDoc" />
<script charset="utf-8" src="../../../javascripts/pdoc/prototype.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/application.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/tabs.js" type="text/javascript"></script>
<script charset="utf-8" src="../../../javascripts/pdoc/item_index.js" type="text/javascript"></script>
<link charset="utf-8" href="../../../stylesheets/pdoc/api.css" media="screen, projection" rel="stylesheet" type="text/css" />
<link charset="utf-8" href="../../../stylesheets/pdoc/pygments.css" media="screen, projection" rel="stylesheet" type="text/css" />
<script type="text/javascript">
PDoc.pathPrefix = '../../../';
</script>
</head>
<body>
<div id="sidebar">
<ul id="sidebar_tabs" class="sidebar-tabs">
<li>
<a href="#menu_pane">Menu</a>
</li>
<li>
<a href="#search_pane">Search</a>
</li>
</ul> <!-- .sidebar-tabs -->
<form class="search-ribbon">
<label>
<span class="hidden">Search</span>
<input type="text" id="search" size="20" title="Search" />
</label>
</form>
<div class="sidebar-pane scrollable" id="menu_pane">
<ul class="menu-items" id="api_menu"><li><div class="menu-item"><a class="class current-parent" href="../../../SpahQL/index.html" title="SpahQL (class)">SpahQL</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Callbacks/index.html" title="SpahQL.Callbacks (class)">SpahQL.Callbacks</a></div></li>
<li><div class="menu-item"><a class="class current-parent" href="../../../SpahQL/DataHelper/index.html" title="SpahQL.DataHelper (class)">SpahQL.DataHelper</a></div><ul><li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/coerceKeyForObject/index.html" title="SpahQL.DataHelper.coerceKeyForObject (class method)">coerceKeyForObject</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/compare/index.html" title="SpahQL.DataHelper.compare (class method)">compare</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/deepClone/index.html" title="SpahQL.DataHelper.deepClone (class method)">deepClone</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eq/index.html" title="SpahQL.DataHelper.eq (class method)">eq</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqArrayRough/index.html" title="SpahQL.DataHelper.eqArrayRough (class method)">eqArrayRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqBooleanRough/index.html" title="SpahQL.DataHelper.eqBooleanRough (class method)">eqBooleanRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqHashRough/index.html" title="SpahQL.DataHelper.eqHashRough (class method)">eqHashRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqNumberRough/index.html" title="SpahQL.DataHelper.eqNumberRough (class method)">eqNumberRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqRough/index.html" title="SpahQL.DataHelper.eqRough (class method)">eqRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqSetRough/index.html" title="SpahQL.DataHelper.eqSetRough (class method)">eqSetRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqSetStrict/index.html" title="SpahQL.DataHelper.eqSetStrict (class method)">eqSetStrict</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/eqStringRough/index.html" title="SpahQL.DataHelper.eqStringRough (class method)">eqStringRough</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/gteSet/index.html" title="SpahQL.DataHelper.gteSet (class method)">gteSet</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/gtSet/index.html" title="SpahQL.DataHelper.gtSet (class method)">gtSet</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/hashKeys/index.html" title="SpahQL.DataHelper.hashKeys (class method)">hashKeys</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/hashValues/index.html" title="SpahQL.DataHelper.hashValues (class method)">hashValues</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/jointSet/index.html" title="SpahQL.DataHelper.jointSet (class method)">jointSet</a></div></li>
<li><div class="menu-item"><a class="class-method current" href="../../../SpahQL/DataHelper/jointSetWithCallback/index.html" title="SpahQL.DataHelper.jointSetWithCallback (class method)">jointSetWithCallback</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/lteSet/index.html" title="SpahQL.DataHelper.lteSet (class method)">lteSet</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/ltSet/index.html" title="SpahQL.DataHelper.ltSet (class method)">ltSet</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/mathCompare/index.html" title="SpahQL.DataHelper.mathCompare (class method)">mathCompare</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/mathGt/index.html" title="SpahQL.DataHelper.mathGt (class method)">mathGt</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/mathGte/index.html" title="SpahQL.DataHelper.mathGte (class method)">mathGte</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/mathLt/index.html" title="SpahQL.DataHelper.mathLt (class method)">mathLt</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/mathLte/index.html" title="SpahQL.DataHelper.mathLte (class method)">mathLte</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/modificationSymbol/index.html" title="SpahQL.DataHelper.modificationSymbol (class method)">modificationSymbol</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/objectType/index.html" title="SpahQL.DataHelper.objectType (class method)">objectType</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/superSet/index.html" title="SpahQL.DataHelper.superSet (class method)">superSet</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../../SpahQL/DataHelper/truthySet/index.html" title="SpahQL.DataHelper.truthySet (class method)">truthySet</a></div></li></ul></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/index.html" title="SpahQL.Errors (class)">SpahQL.Errors</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/SpahQLError/index.html" title="SpahQL.Errors.SpahQLError (class)">SpahQL.Errors.SpahQLError</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Errors/SpahQLRunTimeError/index.html" title="SpahQL.Errors.SpahQLRunTimeError (class)">SpahQL.Errors.SpahQLRunTimeError</a></div></li></ul></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Query/index.html" title="SpahQL.Query (class)">SpahQL.Query</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/QueryParser/index.html" title="SpahQL.QueryParser (class)">SpahQL.QueryParser</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/QueryRunner/index.html" title="SpahQL.QueryRunner (class)">SpahQL.QueryRunner</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Strategiser/index.html" title="SpahQL.Strategiser (class)">SpahQL.Strategiser</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/index.html" title="SpahQL.Token (class)">SpahQL.Token</a></div><ul><li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Base/index.html" title="SpahQL.Token.Base (class)">SpahQL.Token.Base</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Boolean/index.html" title="SpahQL.Token.Boolean (class)">SpahQL.Token.Boolean</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/ComparisonOperator/index.html" title="SpahQL.Token.ComparisonOperator (class)">SpahQL.Token.ComparisonOperator</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/FilterQuery/index.html" title="SpahQL.Token.FilterQuery (class)">SpahQL.Token.FilterQuery</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/KeyName/index.html" title="SpahQL.Token.KeyName (class)">SpahQL.Token.KeyName</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Numeric/index.html" title="SpahQL.Token.Numeric (class)">SpahQL.Token.Numeric</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/PathComponent/index.html" title="SpahQL.Token.PathComponent (class)">SpahQL.Token.PathComponent</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/SelectionQuery/index.html" title="SpahQL.Token.SelectionQuery (class)">SpahQL.Token.SelectionQuery</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Set/index.html" title="SpahQL.Token.Set (class)">SpahQL.Token.Set</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/Simple/index.html" title="SpahQL.Token.Simple (class)">SpahQL.Token.Simple</a></div></li>
<li><div class="menu-item"><a class="class" href="../../../SpahQL/Token/String/index.html" title="SpahQL.Token.String (class)">SpahQL.Token.String</a></div></li></ul></li></ul></li></ul><!--- #api_menu =-->
</div> <!-- .sidebar-pane -->
<div class="sidebar-pane" id="search_pane">
<ul id="search_results" class="search-results menu-items scrollable"></ul>
</div> <!-- .sidebar-pane -->
</div> <!-- #sidebar -->
<div id="page">
<div id="main" class="page-content">
<ul class="breadcrumbs clearfix">
<li><a href="../../../">Home</a></li>
<li>→ <a href="../../../SpahQL/index.html" title="SpahQL (class)">SpahQL</a></li>
<li>→ <a href="../../../SpahQL/DataHelper/index.html" title="SpahQL.DataHelper (class)">DataHelper</a></li>
<li>→ <a href="../../../SpahQL/DataHelper/jointSetWithCallback/index.html" title="SpahQL.DataHelper.jointSetWithCallback (class method)">jointSetWithCallback</a></li>
</ul>
<p id="src_code_href"><a href="http://github.com/danski/spahql/blob/master/src/SpahQL.DataHelper.js#435">src code</a></p>
<h2 class="page-title">
<span class="type">class method</span> SpahQL.DataHelper.jointSetWithCallback
</h2>
<div class="section">
<div class="section-title">
</div> <!-- .section-title -->
<div class="section-content">
<div class="method-description">
<pre class="syntax"><code class="ebnf">SpahQL.DataHelper.jointSetWithCallback(set1, set2, callback) → Boolean result</code></pre>
<ul>
<li>set1 (Array): The value at the left-hand side of the comparator</li>
<li>set2 (Array): The value at the right-hand side of the comparator</li>
<li>callback (Function): A function to be used for comparing the values. Should accept two values as arguments.</li>
</ul>
<p>Iterates over both sets such that every combination of values from the two is passed to the callback function for comparison. If the callback function at any point returns true, the method exits and returns true. Once all combinations have been exhausted and no matches are found, false will be returned.</p>
<p>Mostly used to refactor the various joint set methods (jointSet, eqSetRough, gteSet, gtSet, ltSet, lteSet to name a few).</p>
</div>
</div> <!-- .section-content -->
</div> <!-- .section -->
</div> <!-- #main -->
<div id="footer">
<p><a href="http://danski.github.com/spahql">SpahQL</a> v0.7.0 API documentation.</p>
<p>
Last updated on May 19, 2012 at 14:16 UTC.
Generated by <a href="http://pdoc.org">PDoc</a>.
Uses <a href="http://famfamfam.com/lab/icons/silk/" title="famfamfam.com: Silk Icons">Silk Icons</a> and portions of <a href="http://github.com/280north/aristo/tree/master" title="280north's aristo at master - GitHub">Aristo</a>.
</p>
</div> <!-- #footer -->
</div> <!-- #page -->
</body>
</html>