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

Update docs regarding CompressOptions

Browse source
This commit is contained in:
Alex Hultman 2019-11-18 19:37:30 +01:00
parent 5e205adfbf
commit d053bc377a
12 changed files with 254 additions and 394 deletions
Download patch file Download diff file Expand all files Collapse all files

49
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 v16.1.0 documentation</title>
<title>HttpResponse | uWebSockets.js v16.3.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.1.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -123,7 +123,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L55">index.d.ts:55</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L55">index.d.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -145,7 +145,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L50">index.d.ts:50</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L50">index.d.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -173,7 +173,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L76">index.d.ts:76</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L76">index.d.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -195,7 +195,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L58">index.d.ts:58</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L58">index.d.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -217,7 +217,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L70">index.d.ts:70</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L70">index.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -235,16 +235,10 @@
<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>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
@ -266,7 +260,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L73">index.d.ts:73</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L73">index.d.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -315,7 +309,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L64">index.d.ts:64</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L64">index.d.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -363,7 +357,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L52">index.d.ts:52</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L52">index.d.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -394,7 +388,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L48">index.d.ts:48</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L48">index.d.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -422,7 +416,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L46">index.d.ts:46</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L46">index.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -453,7 +447,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L44">index.d.ts:44</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L44">index.d.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -483,9 +477,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-not-exported">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
@ -546,9 +537,21 @@
<li class=" tsd-kind-interface tsd-is-not-exported">
<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">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#disabled" class="tsd-kind-icon">DISABLED</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#app" class="tsd-kind-icon">App</a>
</li>