lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
717 lines (485 loc) • 20.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Search - lcars-library-node</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="lcars-library-node" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Circulation.html">Circulation</a></li>
<li><a href="../classes/Distress.html">Distress</a></li>
<li><a href="../classes/Edge.html">Edge</a></li>
<li><a href="../classes/Element.html">Element</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Exception.html">Exception</a></li>
<li><a href="../classes/External.html">External</a></li>
<li><a href="../classes/LCARSLibrary.html">LCARSLibrary</a></li>
<li><a href="../classes/LCARSServer.html">LCARSServer</a></li>
<li><a href="../classes/Modification.html">Modification</a></li>
<li><a href="../classes/Random.html">Random</a></li>
<li><a href="../classes/Search.html">Search</a></li>
<li><a href="../classes/Session.html">Session</a></li>
<li><a href="../classes/Set.html">Set</a></li>
<li><a href="../classes/Storage.html">Storage</a></li>
<li><a href="../classes/Terminal.html">Terminal</a></li>
<li><a href="../classes/User.html">User</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Connections.html">Connections</a></li>
<li><a href="../modules/Elements.html">Elements</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Search Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_space_search.js.html#l2"><code>library\space\search.js:2</code></a>
</div>
Module: <a href="../modules/Elements.html">Elements</a>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Search" class="method item">
<h3 class="name"><code>Search</code></h3>
<span class="paren">()</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l2"><code>library\space\search.js:2</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_adjacent">adjacent</a>
</li>
<li class="index-item method">
<a href="#method_path">path</a>
</li>
<li class="index-item method">
<a href="#method_supplies">supplies</a>
</li>
<li class="index-item method">
<a href="#method_supplyConvergence">supplyConvergence</a>
</li>
<li class="index-item method">
<a href="#method_supportConvergence">supportConvergence</a>
</li>
<li class="index-item method">
<a href="#method_supports">supports</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_adjacent" class="method item">
<h3 class="name"><code>adjacent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</code>
</li>
<li class="arg">
<code class="optional">[filter]</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l13"><code>library\space\search.js:13</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">source</code>
<span class="type">String</span>
<div class="param-description">
<p>Element ID</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[filter]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Specifies specific element types to handle differently.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
<div id="method_path" class="method item">
<h3 class="name"><code>path</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>to</code>
</li>
<li class="arg">
<code>from</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l55"><code>library\space\search.js:55</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">to</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">from</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
<div id="method_supplies" class="method item">
<h3 class="name"><code>supplies</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l80"><code>library\space\search.js:80</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
<div id="method_supplyConvergence" class="method item">
<h3 class="name"><code>supplyConvergence</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>ids</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l104"><code>library\space\search.js:104</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ids</code>
<span class="type">Array</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
<div id="method_supportConvergence" class="method item">
<h3 class="name"><code>supportConvergence</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>ids</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l92"><code>library\space\search.js:92</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ids</code>
<span class="type">Array</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
<div id="method_supports" class="method item">
<h3 class="name"><code>supports</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[collection]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_search.js.html#l68"><code>library\space\search.js:68</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collection]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If omitted, only links available to the master space are considered,
otherwise links are used in the specified collection.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>