Skip to content

Commit

Permalink
docs: regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@negezor
negezor committed May 6, 2021
1 parent 269a5ee commit 271d11b
Show file tree
Hide file tree
Showing 50 changed files with 433 additions and 307 deletions.
2 changes: 1 addition & 1 deletion docs/reference/assets/js/search.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/reference/classes/contexts_connections_context.connectioncontext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h3>sent</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.iconnectioncontext.html">IConnectionContext</a>.<a href="../interfaces/interfaces.iconnectioncontext.html#sent">sent</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
45 changes: 36 additions & 9 deletions docs/reference/classes/contexts_connections_http.httpconnectioncontext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ <h3>Properties</h3>
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contexts_connections_http.httpconnectioncontext.html#ip" class="tsd-kind-icon">ip</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contexts_connections_http.httpconnectioncontext.html#passkey" class="tsd-kind-icon">passkey</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contexts_connections_http.httpconnectioncontext.html#url" class="tsd-kind-icon">url</a></li>
</ul>
</section>
Expand All @@ -134,7 +135,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="contexts_connections_context.connectioncontext.html">ConnectionContext</a>.<a href="contexts_connections_context.connectioncontext.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L30">contexts/connections/http.ts:30</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L30">contexts/connections/http.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -157,7 +158,7 @@ <h3>aborted</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#aborted">aborted</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L24">contexts/connections/http.ts:24</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L24">contexts/connections/http.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -172,7 +173,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HttpRequest</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L26">contexts/connections/http.ts:26</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L26">contexts/connections/http.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -182,7 +183,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> response</h3>
<div class="tsd-signature tsd-kind-icon">response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HttpResponse</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L28">contexts/connections/http.ts:28</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L28">contexts/connections/http.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +195,7 @@ <h3>sent</h3>
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#sent">sent</a></p>
<p>Inherited from <a href="contexts_connections_context.connectioncontext.html">ConnectionContext</a>.<a href="contexts_connections_context.connectioncontext.html#sent">sent</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -209,7 +210,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> trust<wbr>Proxy</h3
<div class="tsd-signature tsd-kind-icon">trust<wbr>Proxy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L30">contexts/connections/http.ts:30</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L30">contexts/connections/http.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -227,7 +228,7 @@ <h3>ip</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#ip">ip</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L45">contexts/connections/http.ts:45</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L45">contexts/connections/http.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -239,6 +240,29 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="passkey" class="tsd-anchor"></a>
<h3>passkey</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> passkey<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#passkey">passkey</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L59">contexts/connections/http.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the current URL path</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="url" class="tsd-anchor"></a>
<h3>url</h3>
Expand All @@ -250,7 +274,7 @@ <h3>url</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#url">url</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L55">contexts/connections/http.ts:55</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L55">contexts/connections/http.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -276,7 +300,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.ihttpconnectioncontext.html">IHTTPConnectionContext</a>.<a href="../interfaces/interfaces.ihttpconnectioncontext.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/http.ts#L59">contexts/connections/http.ts:59</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/http.ts#L63">contexts/connections/http.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -346,6 +370,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contexts_connections_http.httpconnectioncontext.html#ip" class="tsd-kind-icon">ip</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contexts_connections_http.httpconnectioncontext.html#passkey" class="tsd-kind-icon">passkey</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contexts_connections_http.httpconnectioncontext.html#url" class="tsd-kind-icon">url</a>
</li>
Expand Down
14 changes: 7 additions & 7 deletions docs/reference/classes/contexts_connections_udp.udpconnectioncontext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="contexts_connections_context.connectioncontext.html">ConnectionContext</a>.<a href="contexts_connections_context.connectioncontext.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L22">contexts/connections/udp.ts:22</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L22">contexts/connections/udp.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -154,7 +154,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> remote<wbr>Info</h3
<div class="tsd-signature tsd-kind-icon">remote<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RemoteInfo</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L22">contexts/connections/udp.ts:22</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L22">contexts/connections/udp.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -166,7 +166,7 @@ <h3>sent</h3>
<p>Implementation of <a href="../interfaces/interfaces.iudpconnectioncontext.html">IUDPConnectionContext</a>.<a href="../interfaces/interfaces.iudpconnectioncontext.html#sent">sent</a></p>
<p>Inherited from <a href="contexts_connections_context.connectioncontext.html">ConnectionContext</a>.<a href="contexts_connections_context.connectioncontext.html#sent">sent</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/context.ts#L4">contexts/connections/context.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -181,7 +181,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> socket</h3>
<div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Socket</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L20">contexts/connections/udp.ts:20</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L20">contexts/connections/udp.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -199,7 +199,7 @@ <h3>ip</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.iudpconnectioncontext.html">IUDPConnectionContext</a>.<a href="../interfaces/interfaces.iudpconnectioncontext.html#ip">ip</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L31">contexts/connections/udp.ts:31</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L31">contexts/connections/udp.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -222,7 +222,7 @@ <h3>port</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.iudpconnectioncontext.html">IUDPConnectionContext</a>.<a href="../interfaces/interfaces.iudpconnectioncontext.html#port">port</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L35">contexts/connections/udp.ts:35</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L35">contexts/connections/udp.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -248,7 +248,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interfaces.iudpconnectioncontext.html">IUDPConnectionContext</a>.<a href="../interfaces/interfaces.iudpconnectioncontext.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/bf5d49a/src/contexts/connections/udp.ts#L39">contexts/connections/udp.ts:39</a></li>
<li>Defined in <a href="https://github.com/negezor/hybrid-torrent-tracker/blob/269a5ee/src/contexts/connections/udp.ts#L39">contexts/connections/udp.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 271d11b

Please sign in to comment.