blob: 609070d787201fc3e9047708f4d8726928db8c31 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: odatajs/deferred</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: odatajs/deferred</h1>
<section>
<header>
<h2>
odatajs/deferred
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="deferred.js.html">deferred.js</a>, <a href="deferred.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="createDeferred"><span class="type-signature">&lt;static> </span>createDeferred<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
createDeferred (see module:datajs/deferred~createDeferred)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="deferred.js.html">deferred.js</a>, <a href="deferred.js.html#line187">line 187</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="DjsDeferred"><span class="type-signature">&lt;static> </span>DjsDeferred<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
DjsDeferred (see <a href="DjsDeferred.html">DjsDeferred</a>)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="deferred.js.html">deferred.js</a>, <a href="deferred.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="createDeferred"><span class="type-signature">&lt;inner> </span>createDeferred<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="DjsDeferred.html">DjsDeferred</a>}</span></h4>
</dt>
<dd>
<div class="description">
Creates a deferred object.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="deferred.js.html">deferred.js</a>, <a href="deferred.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A new deferred object. If jQuery is installed, then a jQueryDeferred object is returned, which provides a superset of features.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="DjsDeferred.html">DjsDeferred</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="forwardCall"><span class="type-signature">&lt;inner> </span>forwardCall<span class="signature">(thisValue, name, returnValue)</span><span class="type-signature"> &rarr; {function}</span></h4>
</dt>
<dd>
<div class="description">
Creates a new function to forward a call.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>thisValue</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Value to use as the 'this' object.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Name of function to forward to.</td>
</tr>
<tr>
<td class="name"><code>returnValue</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Return value for the forward call (helps keep identity when chaining calls).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="deferred.js.html">deferred.js</a>, <a href="deferred.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A new function that will forward a call.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>