Skip to content

GitLab

Commit f4f0c89e authored by Sergiu Gordienco Vasile's avatar Sergiu Gordienco Vasile
Browse files

Update Documentation

parent 6c7f86c5
Hide whitespace changes
Inline Side-by-side
Showing with 33 additions and 21 deletions
documentation/WindowSocket.Client.html
View file @ f4f0c89e
......@@ -1196,5 +1196,7 @@
<script src="scripts/collapse.js" defer></script>
<script src="https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"></script>
</body>
</html>
\ No newline at end of file
documentation/WindowSocket.html
View file @ f4f0c89e
......@@ -1730,5 +1730,7 @@
<script src="scripts/collapse.js" defer></script>
<script src="https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"></script>
</body>
</html>
\ No newline at end of file
documentation/global.html
View file @ f4f0c89e
......@@ -417,5 +417,7 @@
<script src="scripts/collapse.js" defer></script>
<script src="https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"></script>
</body>
</html>
\ No newline at end of file
documentation/index.html
View file @ f4f0c89e
......@@ -108,101 +108,101 @@
<li><a href="#origins-1">origins</a></li>
<li><a href="#client">client</a></li>
</ul>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L187">source</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L187">source</a></h2>
<p>Type: <code>function (): MessageEventSource</code></p>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L198">target</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L198">target</a></h2>
<p>Type: <code>function (): WindowProxy</code></p>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L210">isSameSource</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L210">isSameSource</a></h2>
<p>Type: <code>function (source): boolean</code></p>
<ul>
<li><code>source</code> <strong>MessageEventSource</strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L222">isSameTarget</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L222">isSameTarget</a></h2>
<p>Type: <code>function (target): boolean</code></p>
<ul>
<li><code>target</code> <strong>WindowProxy</strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L234">message</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L234">message</a></h2>
<p>Type: <code>function (args): WindowSocket.Client</code></p>
<ul>
<li><code>args</code> <strong>...<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;any&gt;</strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L256">fire</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L256">fire</a></h2>
<p>Type: <code>function (eventName, args): WindowSocket.Client</code></p>
<ul>
<li><code>eventName</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></strong></li>
<li><code>args</code> <strong>...any</strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L274">disconnect</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L274">disconnect</a></h2>
<p>Type: <code>function ()</code></p>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L6">WindowSocket</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L6">WindowSocket</a></h2>
<p>Type: <code>function (_window)</code></p>
<ul>
<li><code>_window</code> <strong><a href="https://developer.mozilla.org/docs/Web/API/Window">Window</a>?</strong> specify other window to listen</li>
</ul>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L315">stop</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L315">stop</a></h3>
<p>Type: <code>function (): WindowSocket</code></p>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L335">start</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L335">start</a></h3>
<p>Type: <code>function (): WindowSocket</code></p>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L436">broadcast</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L436">broadcast</a></h3>
<p>Type: <code>function (args): WindowSocket</code></p>
<ul>
<li><code>args</code> <strong>...<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;any&gt;</strong></li>
</ul>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L454">fire</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L454">fire</a></h3>
<p>Type: <code>function (args): WindowSocket</code></p>
<ul>
<li><code>args</code> <strong>...<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;any&gt;</strong></li>
</ul>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L475">validateSource</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L475">validateSource</a></h3>
<p>Validate Message Event Source</p>
<p>Type: <code>function (event): WindowSocket.Client</code></p>
<ul>
<li><code>event</code> <strong><a href="https://developer.mozilla.org/docs/Web/API/MessageEvent">MessageEvent</a></strong></li>
</ul>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L527">encoders</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L527">encoders</a></h3>
<p>get current encoders</p>
<p>Type: <code>function ()</code></p>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L527">encoders</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L527">encoders</a></h3>
<p>update encoders</p>
<p>Type: <code>function (encoders): WindowSocket</code></p>
<ul>
<li><code>encoders</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;WindowSocket.Encoder&gt;</strong></li>
</ul>
<hr>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L542">clients</a></h3>
<h3><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L542">clients</a></h3>
<p>Type: <code>function ()</code></p>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L178">WindowSocket.Client</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L178">WindowSocket.Client</a></h2>
<p>Type: <code>function (event)</code></p>
<ul>
<li><code>event</code> <strong><a href="https://developer.mozilla.org/docs/Web/API/MessageEvent">MessageEvent</a></strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L297">origins</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L297">origins</a></h2>
<p>Type: <code>function (origin): WindowSocket</code></p>
<ul>
<li><code>origin</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></strong></li>
</ul>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L297">origins</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L297">origins</a></h2>
<p>Type: <code>function ()</code></p>
<hr>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/09da0abd5437845fe682e4b417fdb1a492a5fa8b/index.js#L486">client</a></h2>
<h2><a href="https://labs.sgapps.io/open-source/window-socket/blob/c03a28dae95f0a5b4fcae27e40f4bcf9509fdc16/index.js#L486">client</a></h2>
<p>Type: <code>function (client)</code></p>
<ul>
<li><code>client</code> <strong><a href="#windowsocketclient">WindowSocket.Client</a></strong></li>
......@@ -235,5 +235,7 @@
<script src="scripts/collapse.js" defer></script>
<script src="https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"></script>
</body>
</html>
\ No newline at end of file
documentation/index.js.html
View file @ f4f0c89e
......@@ -637,5 +637,7 @@ if (typeof(module) === "object" &amp;&amp; module) {
<script src="scripts/collapse.js" defer></script>
<script src="https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"></script>
</body>
</html>
jsdoc.json
View file @ f4f0c89e
......@@ -60,7 +60,9 @@
"navLevel": 1,
"private": false,
"removeQuotes": "none",
"scripts": [],
"scripts": [
"https://sgapps.io/components/sgapps-labs-examples/toolbar/loader.js"
],
"menu": {
"Project Page ( Git Lab )": {
"href":"https://labs.sgapps.io/open-source/window-socket",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment