e2m/uWebSockets.js
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update docs

Browse source
This commit is contained in:
Alex Hultman 2019-03-10 12:52:42 +01:00
parent 91d433d191
commit 38ce62ad07
10 changed files with 134 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

63
docs/generated/interfaces/httprequest.html
View file

@ -86,6 +86,7 @@
<section class="tsd-index-section tsd-is-not-exported">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a></li>
@ -98,6 +99,55 @@
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a name="foreach" class="tsd-anchor"></a>
<h3>for<wbr>Each</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L95">index.d.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Loops over all headers.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cb: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a name="getheader" class="tsd-anchor"></a>
<h3>get<wbr>Header</h3>
@ -108,7 +158,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L79">index.d.ts:79</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L85">index.d.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -136,7 +186,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L85">index.d.ts:85</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L91">index.d.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -158,7 +208,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L81">index.d.ts:81</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L87">index.d.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,7 +236,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L87">index.d.ts:87</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L93">index.d.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +258,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L83">index.d.ts:83</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/91d433d/docs/index.d.ts#L89">index.d.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -243,6 +293,9 @@
<li class="current tsd-kind-interface tsd-is-not-exported">
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a>
</li>