socketstream/socketstream

View on GitHub
docs/partials/api/client.task.html

Summary

Maintainability
Test Coverage
<a href="https://github.com/socketstream/socketstream/edit/master/lib/client/index.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/socketstream/socketstream/blob/3f3f67a/lib/client/index.js#L253" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">task</code>
<div><span class="hint">service in module <code ng:non-bindable="">client</code>
</span>
</div>
</h1>
<div><h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">task(client, name, dependents, fn);</pre>
<h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>client</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="client-task-page"><p>Name of client</p>
</div></td></tr><tr><td>name</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="client-task-page"><p>Name of task</p>
</div></td></tr><tr><td>dependents</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="client-task-page"><p>Array of other client tasks to execute</p>
</div></td></tr><tr><td>fn</td><td><a href="" class="label type-hint type-hint-function">function</a></td><td><div class="client-task-page"><p>Task execution</p>
</div></td></tr></tbody></table></div>
</div>