socketstream/socketstream

View on GitHub
docs/partials/api/ss.add.html

Summary

Maintainability
Test Coverage
<a href="https://github.com/socketstream/socketstream/edit/master/lib/socketstream.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/socketstream/socketstream/blob/3f3f67a/lib/socketstream.js#L86" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">add</code>
<div><span class="hint">service in module <code ng:non-bindable="">ss</code>
</span>
</div>
</h1>
<div><h2 id="description">Description</h2>
<div class="description"><div class="ss-add-page"><p>Call from your app to safely extend the &#39;ss&#39; internal API object passed through to your /server code</p>
</div></div>
<h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">new add(name, 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>name</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ss-add-page"><ul>
<li>Key in the <code>ss</code> API.</li>
</ul>
</div></td></tr><tr><td>fn</td><td><a href="" class="label type-hint type-hint-function">function</a><a href="" class="label type-hint type-hint-number">number</a><a href="" class="label type-hint type-hint-boolean">boolean</a><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ss-add-page"><ul>
<li>value or function</li>
</ul>
</div></td></tr></tbody></table></div>
</div>