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

Wrap WebSocket.cork, update docs

Browse Source
This commit is contained in:
Alex Hultman 2020-01-10 19:02:51 +01:00
parent 6691236309
commit 68fde105e6
13 changed files with 157 additions and 82 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 v16.5.0 documentation" --mode file --readme none .
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v17.0.0 documentation" --mode file --readme none .

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

File diff suppressed because one or more lines are too long

22
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 v16.5.0 documentation</title>
<title>uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="index.html" class="title">uWebSockets.js v17.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 v16.5.0 documentation</h1>
<h1> uWebSockets.js v17.0.0 documentation</h1>
</div>
</div>
</header>
@ -111,7 +111,7 @@
<div class="tsd-signature tsd-kind-icon">Compress<wbr>Options<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/0526685/docs/index.d.ts#L187">index.d.ts:187</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L190">index.d.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -126,7 +126,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/0526685/docs/index.d.ts#L9">index.d.ts:9</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L9">index.d.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -144,7 +144,7 @@
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L193">index.d.ts:193</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L196">index.d.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,7 +159,7 @@
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L189">index.d.ts:189</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L192">index.d.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -174,7 +174,7 @@
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L191">index.d.ts:191</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L194">index.d.ts:194</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -196,7 +196,7 @@
<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#L178">index.d.ts:178</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L181">index.d.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -224,7 +224,7 @@
<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#L181">index.d.ts:181</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L184">index.d.ts:184</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -252,7 +252,7 @@
<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#L184">index.d.ts:184</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L187">index.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

14
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 v16.5.0 documentation</title>
<title>AppOptions | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.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/0526685/docs/index.d.ts#L138">index.d.ts:138</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L141">index.d.ts:141</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/0526685/docs/index.d.ts#L140">index.d.ts:140</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L143">index.d.ts:143</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/0526685/docs/index.d.ts#L137">index.d.ts:137</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L140">index.d.ts:140</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/0526685/docs/index.d.ts#L139">index.d.ts:139</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L142">index.d.ts:142</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/0526685/docs/index.d.ts#L142">index.d.ts:142</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L145">index.d.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

18
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.5.0 documentation</title>
<title>HttpRequest | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -110,7 +110,7 @@
<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#L110">index.d.ts:110</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L113">index.d.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -159,7 +159,7 @@
<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#L100">index.d.ts:100</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L103">index.d.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -187,7 +187,7 @@
<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#L106">index.d.ts:106</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L109">index.d.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -209,7 +209,7 @@
<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#L102">index.d.ts:102</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L105">index.d.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -237,7 +237,7 @@
<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#L108">index.d.ts:108</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L111">index.d.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -259,7 +259,7 @@
<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#L104">index.d.ts:104</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L107">index.d.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -281,7 +281,7 @@
<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>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L115">index.d.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

28
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.5.0 documentation</title>
<title>HttpResponse | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -124,7 +124,7 @@
<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#L55">index.d.ts:55</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L58">index.d.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -146,7 +146,7 @@
<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#L91">index.d.ts:91</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L94">index.d.ts:94</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/0526685/docs/index.d.ts#L50">index.d.ts:50</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L53">index.d.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -223,7 +223,7 @@
<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#L76">index.d.ts:76</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L79">index.d.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -245,7 +245,7 @@
<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#L58">index.d.ts:58</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L61">index.d.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -267,7 +267,7 @@
<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#L70">index.d.ts:70</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L73">index.d.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -310,7 +310,7 @@
<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#L73">index.d.ts:73</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L76">index.d.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -359,7 +359,7 @@
<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#L64">index.d.ts:64</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L67">index.d.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -407,7 +407,7 @@
<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#L52">index.d.ts:52</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L55">index.d.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -438,7 +438,7 @@
<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#L48">index.d.ts:48</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L51">index.d.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -466,7 +466,7 @@
<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#L46">index.d.ts:46</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L49">index.d.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -497,7 +497,7 @@
<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#L44">index.d.ts:44</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L47">index.d.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

32
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 v16.5.0 documentation</title>
<title>TemplatedApp | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -116,7 +116,7 @@
<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#L170">index.d.ts:170</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L173">index.d.ts:173</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -168,7 +168,7 @@
<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#L166">index.d.ts:166</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L169">index.d.ts:169</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -220,7 +220,7 @@
<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#L158">index.d.ts:158</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L161">index.d.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -272,7 +272,7 @@
<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#L152">index.d.ts:152</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L155">index.d.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -324,7 +324,7 @@
<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#L164">index.d.ts:164</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L167">index.d.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -377,7 +377,7 @@
<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#L148">index.d.ts:148</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -420,7 +420,7 @@
<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#L150">index.d.ts:150</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L153">index.d.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -469,7 +469,7 @@
<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#L156">index.d.ts:156</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L159">index.d.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -521,7 +521,7 @@
<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#L160">index.d.ts:160</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L163">index.d.ts:163</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -573,7 +573,7 @@
<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#L154">index.d.ts:154</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L157">index.d.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -625,7 +625,7 @@
<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#L174">index.d.ts:174</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L177">index.d.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -662,7 +662,7 @@
<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#L162">index.d.ts:162</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L165">index.d.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -714,7 +714,7 @@
<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#L168">index.d.ts:168</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L171">index.d.ts:171</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -766,7 +766,7 @@
<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#L172">index.d.ts:172</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L175">index.d.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

4
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 v16.5.0 documentation</title>
<title>us_listen_socket | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">

64
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 v16.5.0 documentation</title>
<title>WebSocket | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -96,6 +96,7 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#close" class="tsd-kind-icon">close</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#cork" class="tsd-kind-icon">cork</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#end" class="tsd-kind-icon">end</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#getbufferedamount" class="tsd-kind-icon">get<wbr>Buffered<wbr>Amount</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a></li>
@ -120,7 +121,7 @@
<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#L23">index.d.ts:23</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L23">index.d.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -132,6 +133,46 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="cork" class="tsd-anchor"></a>
<h3>cork</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">cork<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/6691236/docs/index.d.ts#L35">index.d.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See HttpResponse.cork</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cb: <span class="tsd-signature-type">function</span></h5>
<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><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</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="end" class="tsd-anchor"></a>
<h3>end</h3>
@ -142,7 +183,7 @@
<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#L20">index.d.ts:20</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L20">index.d.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -173,7 +214,7 @@
<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#L17">index.d.ts:17</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L17">index.d.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -195,7 +236,7 @@
<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#L35">index.d.ts:35</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L38">index.d.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -217,7 +258,7 @@
<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#L32">index.d.ts:32</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L32">index.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -254,7 +295,7 @@
<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#L14">index.d.ts:14</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L14">index.d.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -288,7 +329,7 @@
<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#L26">index.d.ts:26</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L26">index.d.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -316,7 +357,7 @@
<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#L29">index.d.ts:29</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L29">index.d.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -366,6 +407,9 @@
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="websocket.html#close" class="tsd-kind-icon">close</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="websocket.html#cork" class="tsd-kind-icon">cork</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="websocket.html#end" class="tsd-kind-icon">end</a>
</li>

20
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 v16.5.0 documentation</title>
<title>WebSocketBehavior | uWebSockets.js v17.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 v16.5.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -107,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/0526685/docs/index.d.ts#L132">index.d.ts:132</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L135">index.d.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -149,7 +149,7 @@
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="../index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L122">index.d.ts:122</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L125">index.d.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -164,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/0526685/docs/index.d.ts#L130">index.d.ts:130</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L133">index.d.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -200,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/0526685/docs/index.d.ts#L120">index.d.ts:120</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L123">index.d.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -215,7 +215,7 @@
<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/0526685/docs/index.d.ts#L124">index.d.ts:124</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L127">index.d.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -230,7 +230,7 @@
<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/0526685/docs/index.d.ts#L118">index.d.ts:118</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L121">index.d.ts:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -245,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/0526685/docs/index.d.ts#L128">index.d.ts:128</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L131">index.d.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -287,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/0526685/docs/index.d.ts#L126">index.d.ts:126</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L129">index.d.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

3
docs/index.d.ts vendored
View File

@ -31,6 +31,9 @@ export interface WebSocket {
/** Publish a message to a topic in MQTT syntax */
publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : WebSocket;
/** See HttpResponse.cork */
cork(cb: () => void) : void;
/** Returns the remote IP address */
getRemoteAddress() : ArrayBuffer;

2
src/HttpResponseWrapper.h
View File

@ -232,7 +232,7 @@ struct HttpResponseWrapper {
}
}
/* Takes function, returns this (EXPERIMENTAL) */
/* Takes function, returns this */
template <bool SSL>
static void res_cork(const FunctionCallbackInfo<Value> &args) {
Isolate *isolate = args.GetIsolate();

28
src/WebSocketWrapper.h
View File

@ -138,6 +138,32 @@ struct WebSocketWrapper {
}
}
/* Takes nothing, returns this */
/*template <bool SSL>
static void uWS_WebSocket_unsubscribeAll(const FunctionCallbackInfo<Value> &args) {
Isolate *isolate = args.GetIsolate();
auto *ws = getWebSocket<SSL>(args);
if (ws) {
ws->unsubscribeAll();
args.GetReturnValue().Set(args.Holder());
}
}*/
/* Takes function, returns this */
template <bool SSL>
static void uWS_WebSocket_cork(const FunctionCallbackInfo<Value> &args) {
Isolate *isolate = args.GetIsolate();
auto *ws = getWebSocket<SSL>(args);
if (ws) {
ws->cork([cb = Local<Function>::Cast(args[0]), isolate]() {
cb->Call(isolate->GetCurrentContext(), isolate->GetCurrentContext()->Global(), 0, nullptr).IsEmpty();
});
args.GetReturnValue().Set(args.Holder());
}
}
template <bool SSL>
static Local<Object> init(Isolate *isolate) {
Local<FunctionTemplate> wsTemplateLocal = FunctionTemplate::New(isolate);
@ -157,6 +183,8 @@ struct WebSocketWrapper {
wsTemplateLocal->PrototypeTemplate()->Set(String::NewFromUtf8(isolate, "subscribe", NewStringType::kNormal).ToLocalChecked(), FunctionTemplate::New(isolate, uWS_WebSocket_subscribe<SSL>));
wsTemplateLocal->PrototypeTemplate()->Set(String::NewFromUtf8(isolate, "unsubscribe", NewStringType::kNormal).ToLocalChecked(), FunctionTemplate::New(isolate, uWS_WebSocket_unsubscribe<SSL>));
wsTemplateLocal->PrototypeTemplate()->Set(String::NewFromUtf8(isolate, "publish", NewStringType::kNormal).ToLocalChecked(), FunctionTemplate::New(isolate, uWS_WebSocket_publish<SSL>));
//wsTemplateLocal->PrototypeTemplate()->Set(String::NewFromUtf8(isolate, "unsubscribeAll", NewStringType::kNormal).ToLocalChecked(), FunctionTemplate::New(isolate, uWS_WebSocket_unsubscribeAll<SSL>));
wsTemplateLocal->PrototypeTemplate()->Set(String::NewFromUtf8(isolate, "cork", NewStringType::kNormal).ToLocalChecked(), FunctionTemplate::New(isolate, uWS_WebSocket_cork<SSL>));
/* Create the template */
Local<Object> wsObjectLocal = wsTemplateLocal->GetFunction(isolate->GetCurrentContext()).ToLocalChecked()->NewInstance(isolate->GetCurrentContext()).ToLocalChecked();