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-12-21 20:46:31 +01:00
parent 0526685633
commit 903dc89240
11 changed files with 462 additions and 360 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HttpRequest | uWebSockets.js v16.3.0 documentation</title>
<title>HttpRequest | uWebSockets.js v16.5.0 documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -83,33 +83,34 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-not-exported">
<section class="tsd-index-section ">
<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>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#setyield" class="tsd-kind-icon">set<wbr>Yield</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<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">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">void</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/5e205ad/docs/index.d.ts#L95">index.d.ts:95</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L110">index.d.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -148,17 +149,17 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getheader" class="tsd-anchor"></a>
<h3>get<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Header<span class="tsd-signature-symbol">(</span>lowerCaseKey<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</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">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L85">index.d.ts:85</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L100">index.d.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -176,17 +177,17 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getmethod" class="tsd-anchor"></a>
<h3>get<wbr>Method</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Method<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L91">index.d.ts:91</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L106">index.d.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -198,17 +199,17 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getparameter" class="tsd-anchor"></a>
<h3>get<wbr>Parameter</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Parameter<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</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">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L87">index.d.ts:87</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L102">index.d.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -226,17 +227,17 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getquery" class="tsd-anchor"></a>
<h3>get<wbr>Query</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Query<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L93">index.d.ts:93</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L108">index.d.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -248,17 +249,17 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="geturl" class="tsd-anchor"></a>
<h3>get<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L89">index.d.ts:89</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L104">index.d.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -270,6 +271,34 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="setyield" class="tsd-anchor"></a>
<h3>set<wbr>Yield</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Yield<span class="tsd-signature-symbol">(</span>yield<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></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/0526685/docs/index.d.ts#L112">index.d.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>yield: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -282,55 +311,58 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-not-exported">
<li class="current tsd-kind-interface">
<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">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<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">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<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">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<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">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httprequest.html#setyield" class="tsd-kind-icon">set<wbr>Yield</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<li class=" tsd-kind-interface">
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-is-not-exported">
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">