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 2020-06-08 14:29:54 +02:00
parent 1b6c029cc1
commit cc3c551831
19 changed files with 1368 additions and 2344 deletions
Download patch file Download diff file Expand all files Collapse all files

164
docs/generated/interfaces/httpresponse.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HttpResponse | uWebSockets.js v17.6.0 documentation</title>
<title>HttpResponse | uWebSockets.js v18.1.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 v17.6.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v18.1.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -98,12 +98,16 @@
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#close" class="tsd-kind-icon">close</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#cork" class="tsd-kind-icon">cork</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#end" class="tsd-kind-icon">end</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#getproxiedremoteaddress" class="tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#getproxiedremoteaddressastext" class="tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address<wbr>AsText</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#getremoteaddressastext" class="tsd-kind-icon">get<wbr>Remote<wbr>Address<wbr>AsText</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#onaborted" class="tsd-kind-icon">on<wbr>Aborted</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#ondata" class="tsd-kind-icon">on<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#onwritable" class="tsd-kind-icon">on<wbr>Writable</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="httpresponse.html#upgrade" class="tsd-kind-icon">upgrade</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#write" class="tsd-kind-icon">write</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#writeheader" class="tsd-kind-icon">write<wbr>Header</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#writestatus" class="tsd-kind-icon">write<wbr>Status</a></li>
@ -124,7 +128,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L97">index.d.ts:97</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L106">index.d.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -146,7 +150,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L133">index.d.ts:133</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -195,7 +199,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L92">index.d.ts:92</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L101">index.d.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -213,6 +217,50 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getproxiedremoteaddress" class="tsd-anchor"></a>
<h3>get<wbr>Proxied<wbr>Remote<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</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/1b6c029/docs/index.d.ts#L133">index.d.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the remote IP address in binary format (4 or 16 bytes), as reported by the PROXY Protocol v2 compatible proxy.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getproxiedremoteaddressastext" class="tsd-anchor"></a>
<h3>get<wbr>Proxied<wbr>Remote<wbr>Address<wbr>AsText</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address<wbr>AsText<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</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/1b6c029/docs/index.d.ts#L136">index.d.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the remote IP address as text, as reported by the PROXY Protocol v2 compatible proxy.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getremoteaddress" class="tsd-anchor"></a>
<h3>get<wbr>Remote<wbr>Address</h3>
@ -223,12 +271,34 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L118">index.d.ts:118</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L127">index.d.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the remote IP address</p>
<p>Returns the remote IP address in binary format (4 or 16 bytes).</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getremoteaddressastext" class="tsd-anchor"></a>
<h3>get<wbr>Remote<wbr>Address<wbr>AsText</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Remote<wbr>Address<wbr>AsText<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</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/1b6c029/docs/index.d.ts#L130">index.d.ts:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the remote IP address as text.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
@ -245,7 +315,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L100">index.d.ts:100</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L109">index.d.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -267,7 +337,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L112">index.d.ts:112</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L121">index.d.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -310,7 +380,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L115">index.d.ts:115</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L124">index.d.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -359,7 +429,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L106">index.d.ts:106</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L115">index.d.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -407,7 +477,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L94">index.d.ts:94</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L103">index.d.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -428,6 +498,52 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<a name="upgrade" class="tsd-anchor"></a>
<h3>upgrade</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">upgrade&lt;T&gt;<span class="tsd-signature-symbol">(</span>userData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, secWebSocketKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, secWebSocketProtocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, secWebSocketExtensions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/1b6c029/docs/index.d.ts#L154">index.d.ts:154</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Upgrades a HttpResponse to a WebSocket. See UpgradeAsync, UpgradeSync example files.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userData: <span class="tsd-signature-type">T</span></h5>
</li>
<li>
<h5>secWebSocketKey: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>secWebSocketProtocol: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>secWebSocketExtensions: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>context: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="write" class="tsd-anchor"></a>
<h3>write</h3>
@ -438,7 +554,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L90">index.d.ts:90</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L99">index.d.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -466,7 +582,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L88">index.d.ts:88</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L97">index.d.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -497,7 +613,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/be45fb6/docs/index.d.ts#L86">index.d.ts:86</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/1b6c029/docs/index.d.ts#L95">index.d.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -547,9 +663,18 @@
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#end" class="tsd-kind-icon">end</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#getproxiedremoteaddress" class="tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#getproxiedremoteaddressastext" class="tsd-kind-icon">get<wbr>Proxied<wbr>Remote<wbr>Address<wbr>AsText</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#getremoteaddressastext" class="tsd-kind-icon">get<wbr>Remote<wbr>Address<wbr>AsText</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a>
</li>
@ -565,6 +690,9 @@
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<a href="httpresponse.html#upgrade" class="tsd-kind-icon">upgrade</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="httpresponse.html#write" class="tsd-kind-icon">write</a>
</li>
@ -590,6 +718,9 @@
<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-interface">
<a href="us_socket_context_t.html" class="tsd-kind-icon">us_<wbr>socket_<wbr>context_<wbr>t</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
@ -652,7 +783,6 @@
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
@ -701,7 +831,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>