129 lines
No EOL
5.3 KiB
HTML
129 lines
No EOL
5.3 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<title>Mithril</title>
|
|
<link href="lib/prism/prism.css" rel="stylesheet" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<nav class="container">
|
|
<a href="index.html" class="logo"><span>○</span> Mithril</a>
|
|
<a href="getting-started.html">Guide</a>
|
|
<a href="mithril.html">API</a>
|
|
<a href="community.html">Community</a>
|
|
<a href="http://lhorie.github.io/mithril-blog">Learn</a>
|
|
<a href="mithril.min.zip">Download</a>
|
|
<a href="http://github.com/lhorie/mithril.js" target="_blank">Github</a>
|
|
</nav>
|
|
</header>
|
|
<main>
|
|
<section class="content">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col(3,3,12)">
|
|
<h2 id="api">API (v0.1.26)</h2>
|
|
<h3 id="core">Core</h3>
|
|
<ul>
|
|
<li><a href="mithril.html" title="A utility to create virtual elements">m</a></li>
|
|
<li><a href="mithril.module.html" title="Initializes a controller/view pair">m.module</a></li>
|
|
<li><a href="mithril.prop.html" title="A getter-setter utility">m.prop</a></li>
|
|
<li><a href="mithril.withAttr.html" title="A event handler factory utility">m.withAttr</a></li>
|
|
</ul>
|
|
<h3 id="routing">Routing</h3>
|
|
<ul>
|
|
<li><a href="mithril.route.html" title="A routing utility">m.route</a>
|
|
<ul>
|
|
<li><a href="mithril.route.html#defining-routes" title="Defines what routes exist">m.route(rootElement, defaultRoute, routes)</a></li>
|
|
<li><a href="mithril.route.html#redirecting" title="Redirects to a route">m.route(path, params)</a></li>
|
|
<li><a href="mithril.route.html#reading-current-route" title="Read the current route">m.route()</a></li>
|
|
<li><a href="mithril.route.html#mode-abstraction" title="Routing mode abstraction">m.route(element)</a></li>
|
|
<li><a href="mithril.route.html#mode" title="Whether routing uses location hash, querystring or pathname">m.route.mode</a></li>
|
|
<li><a href="mithril.route.html#param" title="Read an argument from a parameterized route">m.route.param</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="data">Data</h3>
|
|
<ul>
|
|
<li><a href="mithril.request.html" title="A high-level AJAX utility">m.request</a></li>
|
|
<li><a href="mithril.deferred.html" title="A Promise factory">m.deferred</a></li>
|
|
<li><a href="mithril.sync.html" title="A Promise aggregator">m.sync</a></li>
|
|
</ul>
|
|
<h3 id="html">HTML</h3>
|
|
<ul>
|
|
<li><a href="mithril.trust.html" title="A method to unescape HTML">m.trust</a></li>
|
|
</ul>
|
|
<h3 id="rendering">Rendering</h3>
|
|
<ul>
|
|
<li><a href="mithril.render.html" title="The lowest level rendering method">m.render</a></li>
|
|
<li><a href="mithril.redraw.html" title="A high-level explicit rendering method">m.redraw</a>
|
|
<ul>
|
|
<li><a href="mithril.redraw.html#strategy" title="A flag that drives the rendering strategy for the next redraw">m.redraw.strategy(strategy)</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="mithril.computation.html" title="Utilities to integrate asynchronous contexts to the rendering system">m.startComputation / m.endComputation</a></li>
|
|
</ul>
|
|
<h3 id="data">Testing</h3>
|
|
<ul>
|
|
<li><a href="mithril.deps.html" title="The dependency injector">m.deps</a></li>
|
|
</ul>
|
|
|
|
<h2 id="archive">History</h2>
|
|
<ul>
|
|
<li><a href="roadmap.html">Roadmap</a></li>
|
|
<li><a href="change-log.html">Change log</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="col(9,9,12)">
|
|
<h2 id="m-sync">m.sync</h2>
|
|
<p>This method takes a list of promises and returns a promise that resolves when all promises in the input list have resolved. See <a href="mithril.deferred.html"><code>m.deferred</code></a> for more information on promises.</p>
|
|
<hr>
|
|
<h3 id="usage">Usage</h3>
|
|
<pre><code class="lang-javascript">var greetAsync = function(delay) {
|
|
var deferred = m.deferred();
|
|
setTimeout(function() {
|
|
deferred.resolve("hello");
|
|
}, delay);
|
|
return deferred.promise;
|
|
};
|
|
|
|
m.sync([
|
|
greetAsync(1000),
|
|
greetAsync(1500)
|
|
]).then(function(args) {
|
|
console.log(args); // ["hello", "hello"]
|
|
});
|
|
</code></pre>
|
|
<hr>
|
|
<h3 id="signature">Signature</h3>
|
|
<p><a href="how-to-read-signatures.html">How to read signatures</a></p>
|
|
<pre><code class="lang-clike">Promise sync(Array<Promise> promises)
|
|
|
|
where:
|
|
Promise :: GetterSetter { Promise then(any successCallback(any value), any errorCallback(any value)) }
|
|
GetterSetter :: any getterSetter([any value])
|
|
</code></pre>
|
|
<ul>
|
|
<li><p><strong>Array<Promise> promises</strong></p>
|
|
<p>A list of promises to synchronize</p>
|
|
</li>
|
|
<li><p><strong>return Promise promise</strong></p>
|
|
<p>The promise of the deferred object that is resolved when all input promises have been resolved</p>
|
|
<p>The callbacks for this promise receive as a parameter an Array containing the values of all the input promises</p>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</main>
|
|
<footer>
|
|
<div class="container">
|
|
Released under the <a href="http://opensource.org/licenses/MIT" target="_blank">MIT license</a>
|
|
<br />© 2014 Leo Horie
|
|
</div>
|
|
</footer>
|
|
<script src="lib/prism/prism.js"></script>
|
|
</body>
|
|
</html> |