Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathaniel Camomot committed Dec 28, 2018
1 parent 66998a0 commit 1be01db
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 32 deletions.
18 changes: 7 additions & 11 deletions docs/classes/firepeer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -997,10 +997,6 @@
<p>Secure p2p signalling and authentication for <a href="https://github.com/feross/simple-peer">simple-peer</a>
using <a href="https://firebase.google.com/docs/database/">firebase realtime database</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>noinheritdoc</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
Expand Down Expand Up @@ -1071,7 +1067,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L124">firepeer.ts:124</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L121">firepeer.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1103,7 +1099,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L112">firepeer.ts:112</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L109">firepeer.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1118,7 +1114,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> uid</h3>
<div class="tsd-signature tsd-kind-icon">uid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L117">firepeer.ts:117</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L114">firepeer.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1198,7 +1194,7 @@ <h3>connect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L168">firepeer.ts:168</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L165">firepeer.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1394,7 +1390,7 @@ <h3>on</h3>
<aside class="tsd-sources">
<p>Overrides EventEmitter.on</p>
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L89">firepeer.ts:89</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L87">firepeer.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1436,7 +1432,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</spa
<aside class="tsd-sources">
<p>Overrides EventEmitter.on</p>
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L94">firepeer.ts:94</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L92">firepeer.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1478,7 +1474,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</spa
<aside class="tsd-sources">
<p>Overrides EventEmitter.on</p>
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L99">firepeer.ts:99</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L97">firepeer.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ <h3>Signal<wbr>Interceptor</h3>
<div class="tsd-signature tsd-kind-icon">Signal<wbr>Interceptor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L53">firepeer.ts:53</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L51">firepeer.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 4 additions & 8 deletions docs/interfaces/firepeerinstance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1099,10 +1099,6 @@
<p>The firepeer instance, just a <a href="https://github.com/feross/simple-peer#api">simple-peer</a>
instance in connected state.</p>
</div>
<dl class="tsd-comment-tags">
<dt>noinheritdoc</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
Expand Down Expand Up @@ -1249,7 +1245,7 @@ <h3>initiator<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">initiator<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L21">firepeer.ts:21</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L19">firepeer.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1264,7 +1260,7 @@ <h3>initiator<wbr>Uid</h3>
<div class="tsd-signature tsd-kind-icon">initiator<wbr>Uid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L17">firepeer.ts:17</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L15">firepeer.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1312,7 +1308,7 @@ <h3>receiver<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">receiver<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L29">firepeer.ts:29</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L27">firepeer.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1327,7 +1323,7 @@ <h3>receiver<wbr>Uid</h3>
<div class="tsd-signature tsd-kind-icon">receiver<wbr>Uid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L25">firepeer.ts:25</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L23">firepeer.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/firepeeroptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L61">firepeer.ts:61</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L59">firepeer.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -995,7 +995,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Answer</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Answer<span class="tsd-signature-symbol">:</span> <a href="../index.html#signalinterceptor" class="tsd-signature-type">SignalInterceptor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L73">firepeer.ts:73</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L71">firepeer.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1010,7 +1010,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Offer</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Offer<span class="tsd-signature-symbol">:</span> <a href="../index.html#signalinterceptor" class="tsd-signature-type">SignalInterceptor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L69">firepeer.ts:69</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L67">firepeer.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1025,7 +1025,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> send<wbr>Answer</h3>
<div class="tsd-signature tsd-kind-icon">send<wbr>Answer<span class="tsd-signature-symbol">:</span> <a href="../index.html#signalinterceptor" class="tsd-signature-type">SignalInterceptor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L81">firepeer.ts:81</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L79">firepeer.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1040,7 +1040,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> send<wbr>Offer</h3>
<div class="tsd-signature tsd-kind-icon">send<wbr>Offer<span class="tsd-signature-symbol">:</span> <a href="../index.html#signalinterceptor" class="tsd-signature-type">SignalInterceptor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L77">firepeer.ts:77</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L75">firepeer.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1055,7 +1055,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> sp<wbr>Opts</h3>
<div class="tsd-signature tsd-kind-icon">sp<wbr>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SimplePeer.Options</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L65">firepeer.ts:65</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L63">firepeer.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/signal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -999,7 +999,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L44">firepeer.ts:44</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L42">firepeer.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1025,7 +1025,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"answer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L36">firepeer.ts:36</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L34">firepeer.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -1035,7 +1035,7 @@ <h3>uid</h3>
<div class="tsd-signature tsd-kind-icon">uid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/1614d79/src/firepeer.ts#L40">firepeer.ts:40</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/66998a0/src/firepeer.ts#L38">firepeer.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
3 changes: 0 additions & 3 deletions src/firepeer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import debug from './debug';
/**
* The firepeer instance, just a [simple-peer](https://github.com/feross/simple-peer#api)
* instance in connected state.
*
* @noInheritDoc
*/
export interface FirePeerInstance extends SimplePeer.Instance {
/**
Expand Down Expand Up @@ -103,7 +101,6 @@ export declare interface FirePeer {
* Secure p2p signalling and authentication for [simple-peer](https://github.com/feross/simple-peer)
* using [firebase realtime database](https://firebase.google.com/docs/database/).
*
* @noInheritDoc
*/
export class FirePeer extends EventEmitter {
/**
Expand Down

0 comments on commit 1be01db

Please sign in to comment.