ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openvidu-node-client: declarations hidden (https) or removed (Buffer, require) for docs

pull/73/head
pabloFuente 2018-04-26 17:54:51 +02:00
parent 12dba96ba2
commit 13ec001efd
15 changed files with 16 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
openvidu-node-client/docs/assets/js/search.js
View File

File diff suppressed because one or more lines are too long

27
openvidu-node-client/docs/classes/openvidu.html
View File

@ -111,7 +111,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L35">OpenVidu.ts:35</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L37">OpenVidu.ts:37</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -152,7 +152,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L51">OpenVidu.ts:51</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L53">OpenVidu.ts:53</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -181,7 +181,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L304">OpenVidu.ts:304</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L306">OpenVidu.ts:306</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -216,7 +216,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L205">OpenVidu.ts:205</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L207">OpenVidu.ts:207</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -251,7 +251,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L250">OpenVidu.ts:250</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L252">OpenVidu.ts:252</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -276,7 +276,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L64">OpenVidu.ts:64</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L66">OpenVidu.ts:66</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -306,7 +306,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L65">OpenVidu.ts:65</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L67">OpenVidu.ts:67</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -344,7 +344,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L66">OpenVidu.ts:66</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L68">OpenVidu.ts:68</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -386,7 +386,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L157">OpenVidu.ts:157</a></li> <li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L159">OpenVidu.ts:159</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography"> <div class="tsd-comment tsd-typography">
@ -481,15 +481,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/classes/recording.html
View File

@ -392,15 +392,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/classes/session.html
View File

@ -276,15 +276,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/enums/mediamode.html
View File

@ -167,15 +167,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/enums/openvidurole.html
View File

@ -186,15 +186,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/enums/recording.status.html
View File

@ -270,15 +270,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/enums/recordinglayout.html
View File

@ -224,15 +224,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/enums/recordingmode.html
View File

@ -169,15 +169,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

52
openvidu-node-client/docs/index.html
View File

@ -93,52 +93,9 @@
<li class="tsd-kind-interface"><a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a></li> <li class="tsd-kind-interface"><a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a></li>
</ul> </ul>
</section> </section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#buffer" class="tsd-kind-icon">Buffer</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#https" class="tsd-kind-icon">https</a></li>
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#require" class="tsd-kind-icon">require</a></li>
</ul>
</section>
</div> </div>
</section> </section>
</section> </section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="buffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Buffer</h3>
<div class="tsd-signature tsd-kind-icon">Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L25">Session.ts:25</a></li>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L24">OpenVidu.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="https" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> https</h3>
<div class="tsd-signature tsd-kind-icon">https<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;require(&#x27;https&#x27;)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L28">Session.ts:28</a></li>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L25">OpenVidu.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
<a name="require" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> require</h3>
<div class="tsd-signature tsd-kind-icon">require<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L26">Session.ts:26</a></li>
</ul>
</aside>
</section>
</section>
</div> </div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary"> <nav class="tsd-navigation primary">
@ -180,15 +137,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/interfaces/recordingproperties.html
View File

@ -195,15 +195,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/interfaces/sessionproperties.html
View File

@ -216,15 +216,6 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a> <a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
</li> </li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

9
openvidu-node-client/docs/interfaces/tokenoptions.html
View File

@ -180,15 +180,6 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#https" class="tsd-kind-icon">https</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../index.html#require" class="tsd-kind-icon">require</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>

4
openvidu-node-client/src/OpenVidu.ts
View File

@ -21,7 +21,9 @@ import { Recording } from './Recording';
import { RecordingLayout } from './RecordingLayout'; import { RecordingLayout } from './RecordingLayout';
import { RecordingProperties } from './RecordingProperties'; import { RecordingProperties } from './RecordingProperties';
declare const Buffer; /**
* @hidden
*/
const https = require('https'); const https = require('https');
export class OpenVidu { export class OpenVidu {

6
openvidu-node-client/src/Session.ts
View File

@ -22,9 +22,9 @@ import { RecordingMode } from './RecordingMode';
import { SessionProperties } from './SessionProperties'; import { SessionProperties } from './SessionProperties';
import { TokenOptions } from './TokenOptions'; import { TokenOptions } from './TokenOptions';
declare const Buffer; /**
declare const require; * @hidden
*/
const https = require('https'); const https = require('https');
export class Session { export class Session {