Skip to content
This repository has been archived by the owner on Dec 28, 2018. It is now read-only.

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dbartholomae committed Jan 8, 2016
1 parent 08825f2 commit 2862875
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 17 deletions.
2 changes: 1 addition & 1 deletion doc/alphabetical_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ <h2>File Listing A-Z</h2>
</div>
</div>
<div id='footer'>
January 08, 16 04:37:45 by
January 08, 16 04:49:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Expand Down
2 changes: 1 addition & 1 deletion doc/class/ExtendedPromise.html
Original file line number Diff line number Diff line change
Expand Up @@ -1022,7 +1022,7 @@ <h3>Returns:</h3>
</div>
</div>
<div id='footer'>
January 08, 16 04:37:45 by
January 08, 16 04:49:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Expand Down
2 changes: 1 addition & 1 deletion doc/extra/CHANGELOG.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3 id="breaking-changes">Breaking Changes</h3>
</div>
</div>
<div id='footer'>
January 08, 16 04:37:45 by
January 08, 16 04:49:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Expand Down
15 changes: 2 additions & 13 deletions doc/extra/README.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,11 @@ <h1 id="ng-q-plus">ng-q-plus</h1><p><a href="https://npmjs.org/package/ng-q-plus
<h2 id="api">API</h2><p>The module can be required via browserify require, as an AMD module via requirejs or as a global, if window.angular is
present. It creates the angular module &#39;ng-q-plus&#39; and exports its name. This module augments the existing
<code>$q</code> service, it does not create a service of its own.
Each promise gets the new methods as defined in the <a href="doc/class/ExtendedPromise.html">ExtendedPromise class</a></p><h3 id="-ispending-"><code>isPending()</code></h3><p>Returns true if the promise is pending (<code>promise.$$state.status &lt;= 0</code>)</p><h3 id="-isfulfilled-"><code>isFulfilled()</code></h3><p>Returns true if the promise is fulfilled (<code>promise.$$state.status == 1</code>)</p><h3 id="-isrejected-"><code>isRejected()</code></h3><p>Returns true if the promise is rejected (<code>promise.$$state.status == 2</code>)</p><h3 id="-timeout-time_ms-cb-"><code>timeout(time_ms, cb)</code></h3><p>Checks after <code>time_ms</code> milliseconds whether the promise is still pending. If it is, then <code>cb</code> is called with
the deferred object for this promise as an argument. If <code>cb</code> isn&#39;t a function, the promise instead rejects
with <code>cb</code> as error. If <code>cb</code> is <code>undefined</code>, the promise rejects with <code>&quot;Timed out after &quot; + time_ms + &quot; ms&quot;</code>.
<code>timeout</code> is implemented via <code>$browser.defer</code>. In tests it has to be flushed via <code>$browser.defer.flush()</code>.</p><h3 id="-tap-cb-"><code>tap(cb)</code></h3><p>Equivalent to <code>then (value) -&gt; cb value; return value</code></p><h3 id="-get-attr-"><code>get(attr)</code></h3><p>Equivalent to <code>then (o) -&gt; o[attr]</code></p><h3 id="-set-attr-val-"><code>set(attr, val)</code></h3><p>If <code>val</code> and <code>attr</code> are not promises this is equivalent to <code>tap (o) -&gt; o[attr] = val</code>.
If <code>val</code> or <code>attr</code> are promises these get resolved and <code>set</code> works as written above.
Please note that this can lead to side effects.</p><h3 id="-post-method-args-"><code>post(method, args)</code></h3><p>Equivalent to <code>then (o) -&gt; o[method].apply o, args</code></p><h3 id="-invoke-method-arg1-arg2-"><code>invoke(method, arg1, arg2, ...)</code></h3><p>Equivalent to <code>then (o) -&gt; o[method].apply o, [arg1, arg2, ...]</code></p><h3 id="-send-method-arg1-arg2-"><code>send(method, arg1, arg2, ...)</code></h3><p>Alternative name for <code>invoke</code></p><h3 id="-keys-"><code>keys()</code></h3><p>Equivalent to <code>then (o) -&gt; Object.keys o</code></p><h3 id="-fapply-args-"><code>fapply(args)</code></h3><p>Equivalent to <code>then (f) -&gt; f.apply undefined, args</code></p><h3 id="-fcall-arg1-arg2-"><code>fcall(arg1, arg2, ...)</code></h3><p>Equivalent to <code>then (f) -&gt; f.apply undefined, [arg1, arg2, ...]</code></p><h3 id="-all-"><code>all()</code></h3><p>Equivalent to <code>then (arr) -&gt; $q.all arr</code></p><h3 id="-props-"><code>props()</code></h3><p>Alternative name for <code>all</code></p><h3 id="-map-cb-"><code>map(cb)</code></h3><p>For promises for arrays equivalent to <code>all().then (arr) -&gt; $q.all arr.map cb</code>.
For promises for objects <code>obj</code> the callback gets called as <code>cb(key, obj[key])</code>
for all own properties of <code>obj</code> and uses the results from the callback to update
these values.</p><h3 id="-each-cb-"><code>each(cb)</code></h3><p>Equivalent to <code>@map (el) -&gt; cb el; el</code></p><h3 id="-join-p1-p2-cb-"><code>join(p1, p2, ..., cb)</code></h3><p>Calls <code>cb(v0, v1, v2, ...)</code> with <code>v0</code> being the value of the resolved promise
itself and <code>v1, v2, ...</code> being the values of the resolved promises
<code>v1, v2, ...</code>. It returns a promise for the result of <code>cb</code>.
If any promise rejects, it returns a promise rejected with the same reason. </p>
Each promise gets the new methods as defined in the ExtendedPromise class which can be found in the <a href="https://cdn.rawgit.com/dbartholomae/ng-q-plus/master/doc/index.html">documentation</a>.</p>
</div>
</div>
<div id='footer'>
January 08, 16 04:37:45 by
January 08, 16 04:49:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Expand Down
2 changes: 1 addition & 1 deletion doc/file/src/ng-q-plus.coffee.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h1>
</table>
</div>
<div id='footer'>
January 08, 16 04:37:45 by
January 08, 16 04:49:33 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
Expand Down

0 comments on commit 2862875

Please sign in to comment.