Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathaniel Camomot committed Dec 27, 2018
1 parent a16aa7d commit ffb1342
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
14 changes: 7 additions & 7 deletions docs/classes/firepeer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/99c292d/src/firepeer.ts#L124">firepeer.ts:124</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L124">firepeer.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1035,7 +1035,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/99c292d/src/firepeer.ts#L112">firepeer.ts:112</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L112">firepeer.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1050,7 +1050,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/99c292d/src/firepeer.ts#L117">firepeer.ts:117</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L117">firepeer.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1073,7 +1073,7 @@ <h3>connect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/99c292d/src/firepeer.ts#L168">firepeer.ts:168</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L168">firepeer.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1107,7 +1107,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/99c292d/src/firepeer.ts#L89">firepeer.ts:89</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L89">firepeer.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1149,7 +1149,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/99c292d/src/firepeer.ts#L94">firepeer.ts:94</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L94">firepeer.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1191,7 +1191,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/99c292d/src/firepeer.ts#L99">firepeer.ts:99</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L99">firepeer.ts:99</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/99c292d/src/firepeer.ts#L53">firepeer.ts:53</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L53">firepeer.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/firepeerinstance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -992,7 +992,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/99c292d/src/firepeer.ts#L21">firepeer.ts:21</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L21">firepeer.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1007,7 +1007,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/99c292d/src/firepeer.ts#L17">firepeer.ts:17</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L17">firepeer.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1022,7 +1022,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/99c292d/src/firepeer.ts#L29">firepeer.ts:29</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L29">firepeer.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1037,7 +1037,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/99c292d/src/firepeer.ts#L25">firepeer.ts:25</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L25">firepeer.ts:25</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/99c292d/src/firepeer.ts#L61">firepeer.ts:61</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L61">firepeer.ts:61</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/99c292d/src/firepeer.ts#L73">firepeer.ts:73</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L73">firepeer.ts:73</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/99c292d/src/firepeer.ts#L69">firepeer.ts:69</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L69">firepeer.ts:69</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/99c292d/src/firepeer.ts#L81">firepeer.ts:81</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L81">firepeer.ts:81</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/99c292d/src/firepeer.ts#L77">firepeer.ts:77</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L77">firepeer.ts:77</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/99c292d/src/firepeer.ts#L65">firepeer.ts:65</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L65">firepeer.ts:65</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/99c292d/src/firepeer.ts#L44">firepeer.ts:44</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L44">firepeer.ts:44</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/99c292d/src/firepeer.ts#L36">firepeer.ts:36</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L36">firepeer.ts:36</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/99c292d/src/firepeer.ts#L40">firepeer.ts:40</a></li>
<li>Defined in <a href="https://github.com/natzcam/firepeer/blob/8cad537/src/firepeer.ts#L40">firepeer.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit ffb1342

Please sign in to comment.