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

fix typedoc, gen latest docs (#599)

Browse source 
* fix typedoc

* gen docs

* fix version #

Co-authored-by: e3dio <>
This commit is contained in:
e3dio 2021-08-15 17:34:38 -07:00 • committed by GitHub
parent 8f5383157d
commit 935ca2cab8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 1810 additions and 1227 deletions
Download patch file Download diff file Expand all files Collapse all files

108
docs/generated/interfaces/appoptions.html
View file

@ -3,10 +3,11 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AppOptions | uWebSockets.js v19.0.0 documentation</title>
<meta name="description" content="Documentation for uWebSockets.js v19.0.0 documentation">
<title>AppOptions | uWebSockets.js v19.3.0 documentation</title>
<meta name="description" content="Documentation for uWebSockets.js v19.3.0 documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
@ -22,7 +23,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 v19.0.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v19.3.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -38,8 +39,6 @@
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@ -51,10 +50,10 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
<a href="../index.html">uWebSockets.js v19.3.0 documentation</a>
</li>
<li>
<a href="appoptions.html">AppOptions</a>
<a href="AppOptions.html">AppOptions</a>
</li>
</ul>
<h1>Interface AppOptions</h1>
@ -87,11 +86,11 @@
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AppOptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a></li>
</ul>
</section>
</div>
@ -102,40 +101,40 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="cert_file_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cert_<wbr>file_<wbr>name</h3>
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L256">index.d.ts:256</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L263">index.d.ts:263</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dh_params_file_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dh_<wbr>params_<wbr>file_<wbr>name</h3>
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L258">index.d.ts:258</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L265">index.d.ts:265</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="key_file_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> key_<wbr>file_<wbr>name</h3>
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L255">index.d.ts:255</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L262">index.d.ts:262</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="passphrase" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> passphrase</h3>
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L257">index.d.ts:257</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L264">index.d.ts:264</a></li>
</ul>
</aside>
</section>
@ -145,7 +144,7 @@
<div class="tsd-signature tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage<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/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L260">index.d.ts:260</a></li>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L267">index.d.ts:267</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,112 +158,118 @@
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/listenoptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
<a href="../enums/ListenOptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
<a href="AppOptions.html" class="tsd-kind-icon">App<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a>
<a href="AppOptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a>
<a href="AppOptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a>
<a href="AppOptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a>
<a href="AppOptions.html#passphrase" class="tsd-kind-icon">passphrase</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a>
<a href="AppOptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
<a href="HttpRequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
<a href="HttpResponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="multipartfield.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
<a href="MultipartField.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
</li>
<li class=" tsd-kind-interface">
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
<a href="TemplatedApp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface">
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
<a href="WebSocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
<a href="WebSocketBehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
</li>
<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.html" class="tsd-kind-icon">us_<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>
<a href="../index.html#CompressOptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
<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_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_128KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_16kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>16KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_16KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>16KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_256kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_256KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_32kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_32KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_3kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_3KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_4kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_4KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_64kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_64KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#dedicated_compressor_8kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a>
<a href="../index.html#DEDICATED_COMPRESSOR_8KB" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#disabled" class="tsd-kind-icon">DISABLED</a>
<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>
<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>
<a href="../index.html#App" class="tsd-kind-icon">App</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#sslapp" class="tsd-kind-icon">SSLApp</a>
<a href="../index.html#SSLApp" class="tsd-kind-icon">SSLApp</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#getparts" class="tsd-kind-icon">get<wbr>Parts</a>
<a href="../index.html#getParts" class="tsd-kind-icon">get<wbr>Parts</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#us_socket_local_port" class="tsd-kind-icon">us_<wbr>socket_<wbr>local_<wbr>port</a>
</li>
</ul>
</nav>
</div>
@ -286,6 +291,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>