spahql
Version:
A query language and data model for deep Javascript object structures.
180 lines (135 loc) • 14.7 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 | new SpahQL</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" href="../../SpahQL/DataHelper/index.html" title="SpahQL.DataHelper (class)">SpahQL.DataHelper</a></div></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><ul><li><div class="menu-item"><a class="constructor current" href="../../SpahQL/new/index.html" title="new SpahQL (constructor)">new</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/assert/index.html" title="SpahQL.assert (class method)">assert</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/db/index.html" title="SpahQL.db (class method)">db</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/inBrowser/index.html" title="SpahQL.inBrowser (class method)">inBrowser</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/isHeadless/index.html" title="SpahQL.isHeadless (class method)">isHeadless</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/log/index.html" title="SpahQL.log (class method)">log</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/result/index.html" title="SpahQL.result (class method)">result</a></div></li>
<li><div class="menu-item"><a class="class-method" href="../../SpahQL/select/index.html" title="SpahQL.select (class method)">select</a></div></li>
<li><div class="menu-item"><a class="class-property" href="../../SpahQL/verbose/index.html" title="SpahQL.verbose (class property)">verbose</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/assert/index.html" title="SpahQL#assert (instance method)">assert</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/clone/index.html" title="SpahQL#clone (instance method)">clone</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/concat/index.html" title="SpahQL#concat (instance method)">concat</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/containing/index.html" title="SpahQL#containing (instance method)">containing</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/containingAll/index.html" title="SpahQL#containingAll (instance method)">containingAll</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/destroy/index.html" title="SpahQL#destroy (instance method)">destroy</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/destroyAll/index.html" title="SpahQL#destroyAll (instance method)">destroyAll</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/detach/index.html" title="SpahQL#detach (instance method)">detach</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/each/index.html" title="SpahQL#each (instance method)">each</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/filter/index.html" title="SpahQL#filter (instance method)">filter</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/first/index.html" title="SpahQL#first (instance method)">first</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/item/index.html" title="SpahQL#item (instance method)">item</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/keyName/index.html" title="SpahQL#keyName (instance method)">keyName</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/keyNames/index.html" title="SpahQL#keyNames (instance method)">keyNames</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/last/index.html" title="SpahQL#last (instance method)">last</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/listen/index.html" title="SpahQL#listen (instance method)">listen</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/map/index.html" title="SpahQL#map (instance method)">map</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/parent/index.html" title="SpahQL#parent (instance method)">parent</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/parentPath/index.html" title="SpahQL#parentPath (instance method)">parentPath</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/parentPaths/index.html" title="SpahQL#parentPaths (instance method)">parentPaths</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/parents/index.html" title="SpahQL#parents (instance method)">parents</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/path/index.html" title="SpahQL#path (instance method)">path</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/paths/index.html" title="SpahQL#paths (instance method)">paths</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/replace/index.html" title="SpahQL#replace (instance method)">replace</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/replaceAll/index.html" title="SpahQL#replaceAll (instance method)">replaceAll</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/resultModified/index.html" title="SpahQL#resultModified (instance method)">resultModified</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/select/index.html" title="SpahQL#select (instance method)">select</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/set/index.html" title="SpahQL#set (instance method)">set</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/setAll/index.html" title="SpahQL#setAll (instance method)">setAll</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/sourceData/index.html" title="SpahQL#sourceData (instance method)">sourceData</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/type/index.html" title="SpahQL#type (instance method)">type</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/types/index.html" title="SpahQL#types (instance method)">types</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/unlisten/index.html" title="SpahQL#unlisten (instance method)">unlisten</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/value/index.html" title="SpahQL#value (instance method)">value</a></div></li>
<li><div class="menu-item"><a class="instance-method" href="../../SpahQL/prototype/values/index.html" title="SpahQL#values (instance method)">values</a></div></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/new/index.html" title="new SpahQL (constructor)">new</a></li>
</ul>
<p id="src_code_href"><a href="http://github.com/danski/spahql/blob/master/src/SpahQL.js#241">src code</a></p>
<h2 class="page-title">
<span class="type">constructor</span> new SpahQL
</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">new SpahQL(results[, result1][, result2])</code></pre>
<p>Instantiate a new SpahQL monad with the given set of results. Each result is an object with keys “path” (indicating the absolute path of the item), “value” (indicating the value at this path) and “sourceData” (indicating the original data structure from which this data was culled).</p>
<p>It’s recommended that you leave this method to be used by Spah’s internals, and instead use SpahQL.db(data) to create new SpahQL resources.</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>