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

Update docs for v16.0.0

Browse Source
This commit is contained in:
Alex Hultman 2019-10-09 15:24:56 +02:00
parent cfbcb55b03
commit d605d97fa3
19 changed files with 2364 additions and 871 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -1,2 +1,2 @@
default:
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v15.11.0 documentation" --mode file --readme none .
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v16.0.0 documentation" --mode file --readme none .

2996
docs/generated/assets/css/main.css Executable file → Normal file
View File

File diff suppressed because it is too large Load Diff

7
docs/generated/assets/css/main.css.map
View File

File diff suppressed because one or more lines are too long

BIN
docs/generated/assets/images/icons.png Executable file → Normal file
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.3 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

BIN
docs/generated/assets/images/icons@2x.png Executable file → Normal file
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 28 KiB

0
docs/generated/assets/images/widgets.png Executable file → Normal file
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 480 B

After

Width:  |  Height:  |  Size: 480 B

0
docs/generated/assets/images/widgets@2x.png Executable file → Normal file
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 855 B

After

Width:  |  Height:  |  Size: 855 B

6
docs/generated/assets/js/main.js vendored Executable file → Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/generated/assets/js/search.js vendored
View File

File diff suppressed because one or more lines are too long

13
docs/generated/enums/compressoptions.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CompressOptions | uWebSockets.js v15.11.0 documentation</title>
<title>CompressOptions | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -94,7 +94,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L172">index.d.ts:172</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L174">index.d.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -109,7 +109,7 @@
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L168">index.d.ts:168</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L170">index.d.ts:170</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -124,7 +124,7 @@
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L170">index.d.ts:170</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L172">index.d.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -213,6 +213,7 @@
<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>
@ -261,7 +262,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

17
docs/generated/index.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>uWebSockets.js v15.11.0 documentation</title>
<title>uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -54,7 +54,7 @@
<a href="index.html">Globals</a>
</li>
</ul>
<h1> uWebSockets.js v15.11.0 documentation</h1>
<h1> uWebSockets.js v16.0.0 documentation</h1>
</div>
</div>
</header>
@ -108,7 +108,7 @@
<div class="tsd-signature tsd-kind-icon">Recognized<wbr>String<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float64Array</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L9">index.d.ts:9</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L9">index.d.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -130,7 +130,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L157">index.d.ts:157</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L159">index.d.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -158,7 +158,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L160">index.d.ts:160</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L162">index.d.ts:162</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,7 +186,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L163">index.d.ts:163</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L165">index.d.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -269,6 +269,7 @@
<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>
@ -317,7 +318,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>

17
docs/generated/interfaces/appoptions.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AppOptions | uWebSockets.js v15.11.0 documentation</title>
<title>AppOptions | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -104,7 +104,7 @@
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L119">index.d.ts:119</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L121">index.d.ts:121</a></li>
</ul>
</aside>
</section>
@ -114,7 +114,7 @@
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L121">index.d.ts:121</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L123">index.d.ts:123</a></li>
</ul>
</aside>
</section>
@ -124,7 +124,7 @@
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L118">index.d.ts:118</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L120">index.d.ts:120</a></li>
</ul>
</aside>
</section>
@ -134,7 +134,7 @@
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L120">index.d.ts:120</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L122">index.d.ts:122</a></li>
</ul>
</aside>
</section>
@ -144,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/a5cf0db/docs/index.d.ts#L123">index.d.ts:123</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L125">index.d.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -239,6 +239,7 @@
<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>
@ -287,7 +288,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

19
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 v15.11.0 documentation</title>
<title>HttpRequest | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -109,7 +109,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L95">index.d.ts:95</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L95">index.d.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -158,7 +158,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L85">index.d.ts:85</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L85">index.d.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,7 +186,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L91">index.d.ts:91</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L91">index.d.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +208,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L87">index.d.ts:87</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L87">index.d.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -236,7 +236,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L93">index.d.ts:93</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L93">index.d.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -258,7 +258,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L89">index.d.ts:89</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L89">index.d.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -359,6 +359,7 @@
<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>
@ -407,7 +408,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

29
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 v15.11.0 documentation</title>
<title>HttpResponse | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.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/a5cf0db/docs/index.d.ts#L55">index.d.ts:55</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/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/a5cf0db/docs/index.d.ts#L50">index.d.ts:50</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/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/a5cf0db/docs/index.d.ts#L76">index.d.ts:76</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/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/a5cf0db/docs/index.d.ts#L58">index.d.ts:58</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/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/a5cf0db/docs/index.d.ts#L70">index.d.ts:70</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L70">index.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -266,7 +266,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L73">index.d.ts:73</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L73">index.d.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -315,7 +315,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L64">index.d.ts:64</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L64">index.d.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -363,7 +363,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L52">index.d.ts:52</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L52">index.d.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -394,7 +394,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L48">index.d.ts:48</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L48">index.d.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -422,7 +422,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L46">index.d.ts:46</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L46">index.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -453,7 +453,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L44">index.d.ts:44</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L44">index.d.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -575,6 +575,7 @@
<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>
@ -623,7 +624,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

33
docs/generated/interfaces/templatedapp.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TemplatedApp | uWebSockets.js v15.11.0 documentation</title>
<title>TemplatedApp | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L151">index.d.ts:151</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L153">index.d.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -167,7 +167,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L147">index.d.ts:147</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L149">index.d.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -219,7 +219,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L139">index.d.ts:139</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L141">index.d.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +271,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L133">index.d.ts:133</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L135">index.d.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -323,7 +323,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L145">index.d.ts:145</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L147">index.d.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -376,7 +376,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L129">index.d.ts:129</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L131">index.d.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -419,7 +419,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L131">index.d.ts:131</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L133">index.d.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -468,7 +468,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L137">index.d.ts:137</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L139">index.d.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -520,7 +520,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L143">index.d.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -572,7 +572,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L135">index.d.ts:135</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L137">index.d.ts:137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -624,7 +624,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L143">index.d.ts:143</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L145">index.d.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -676,7 +676,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L149">index.d.ts:149</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -728,7 +728,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L153">index.d.ts:153</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L155">index.d.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -856,6 +856,7 @@
<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>
@ -904,7 +905,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

7
docs/generated/interfaces/us_listen_socket.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>us_listen_socket | uWebSockets.js v15.11.0 documentation</title>
<title>us_listen_socket | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -147,6 +147,7 @@
<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>
@ -195,7 +196,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

37
docs/generated/interfaces/websocket.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebSocket | uWebSockets.js v15.11.0 documentation</title>
<title>WebSocket | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -120,7 +120,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L23">index.d.ts:23</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L23">index.d.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -142,7 +142,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L20">index.d.ts:20</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L20">index.d.ts:20</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/a5cf0db/docs/index.d.ts#L17">index.d.ts:17</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L17">index.d.ts:17</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/a5cf0db/docs/index.d.ts#L35">index.d.ts:35</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L35">index.d.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -211,13 +211,13 @@
<a name="publish" class="tsd-anchor"></a>
<h3>publish</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<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><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<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="websocket.html" class="tsd-signature-type">WebSocket</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/a5cf0db/docs/index.d.ts#L29">index.d.ts:29</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L32">index.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -233,6 +233,12 @@
<li>
<h5>message: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> isBinary: <span class="tsd-signature-type">boolean</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> compress: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="websocket.html" class="tsd-signature-type">WebSocket</a></h4>
</li>
@ -248,7 +254,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L14">index.d.ts:14</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L14">index.d.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -282,7 +288,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L26">index.d.ts:26</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L26">index.d.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -304,18 +310,18 @@
<a name="unsubscribe" class="tsd-anchor"></a>
<h3>unsubscribe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>topic<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><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>topic<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">boolean</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/a5cf0db/docs/index.d.ts#L32">index.d.ts:32</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L29">index.d.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unsubscribe from topic (not implemented yet)</p>
<p>Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -324,7 +330,7 @@
<h5>topic: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="websocket.html" class="tsd-signature-type">WebSocket</a></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
@ -423,6 +429,7 @@
<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>
@ -471,7 +478,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

40
docs/generated/interfaces/websocketbehavior.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebSocketBehavior | uWebSockets.js v15.11.0 documentation</title>
<title>WebSocketBehavior | uWebSockets.js v16.0.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 v15.11.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -90,6 +90,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a></li>
@ -106,7 +107,7 @@
<div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L113">index.d.ts:113</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L115">index.d.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -148,7 +149,7 @@
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="../enums/compressoptions.html" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L105">index.d.ts:105</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L105">index.d.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -163,7 +164,7 @@
<div class="tsd-signature tsd-kind-icon">drain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L111">index.d.ts:111</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L113">index.d.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -199,7 +200,7 @@
<div class="tsd-signature tsd-kind-icon">idle<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L103">index.d.ts:103</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L103">index.d.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,13 +209,28 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
<a name="maxbackpressure" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Backpressure</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Backpressure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L107">index.d.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum length of allowed backpressure per socket when publishing messages. Slow receivers, WebSockets, will be disconnected if needed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
<a name="maxpayloadlength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Payload<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Payload<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L101">index.d.ts:101</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L101">index.d.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -229,7 +245,7 @@
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L109">index.d.ts:109</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L111">index.d.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +287,7 @@
<div class="tsd-signature tsd-kind-icon">open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/a5cf0db/docs/index.d.ts#L107">index.d.ts:107</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L109">index.d.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -351,6 +367,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
<a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
<a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
<a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a>
</li>
@ -396,6 +415,7 @@
<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>
@ -444,7 +464,7 @@
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>

10
docs/index.d.ts vendored
View File

@ -25,11 +25,11 @@ interface WebSocket {
/** Subscribe to a topic in MQTT syntax */
subscribe(topic: RecognizedString) : WebSocket;
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString) : WebSocket;
/** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */
unsubscribe(topic: RecognizedString) : boolean;
/** Unsubscribe from topic (not implemented yet) */
unsubscribe(topic: RecognizedString) : WebSocket;
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : WebSocket;
/** Returns the remote IP address */
getRemoteAddress() : ArrayBuffer;
@ -103,6 +103,8 @@ interface WebSocketBehavior {
idleTimeout?: number;
/** 0 = no compression, 1 = shared compressor, 2 = dedicated compressor. See C++ project. */
compression?: CompressOptions;
/** Maximum length of allowed backpressure per socket when publishing messages. Slow receivers, WebSockets, will be disconnected if needed. */
maxBackpressure?: number;
/** Handler for new WebSocket connection. WebSocket is valid from open to close, no errors. */
open?: (ws: WebSocket, req: HttpRequest) => void;
/** Handler for a WebSocket message. */