Update docs a v15.6.0
This commit is contained in:
Alex Hultman
parent
3ce5d37366
commit
c1fef4ed20
@ -1,2 +1,2 @@
|
||||
default:
|
||||
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v15.1.0 documentation (WIP & incomplete)" --mode file --readme none .
|
||||
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v15.6.0 documentation" --mode file --readme none .
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>CompressOptions | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>CompressOptions | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.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/dcfbd23/docs/index.d.ts#L153">index.d.ts:153</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L162">index.d.ts:162</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/dcfbd23/docs/index.d.ts#L149">index.d.ts:149</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L158">index.d.ts:158</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/dcfbd23/docs/index.d.ts#L151">index.d.ts:151</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L160">index.d.ts:160</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -184,6 +184,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="../interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="index.html" class="title">uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</h1>
|
||||
<h1> uWebSockets.js v15.6.0 documentation</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
@ -83,6 +83,12 @@
|
||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
@ -94,6 +100,24 @@
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a name="recognizedstring" class="tsd-anchor"></a>
|
||||
<h3>Recognized<wbr>String</h3>
|
||||
<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/3ce5d37/docs/index.d.ts#L9">index.d.ts:9</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Recognized string types, things C++ can read and understand as strings</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
@ -106,7 +130,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L138">index.d.ts:138</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L147">index.d.ts:147</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -134,7 +158,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L141">index.d.ts:141</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L150">index.d.ts:150</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -162,7 +186,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L144">index.d.ts:144</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L153">index.d.ts:153</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -216,6 +240,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>AppOptions | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>AppOptions | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -100,40 +100,40 @@
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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> <span class="tsd-signature-type">string</span></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">RecognizedString</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L102">index.d.ts:102</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L111">index.d.ts:111</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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> <span class="tsd-signature-type">string</span></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">RecognizedString</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L104">index.d.ts:104</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L113">index.d.ts:113</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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> <span class="tsd-signature-type">string</span></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">RecognizedString</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L101">index.d.ts:101</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L110">index.d.ts:110</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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> <span class="tsd-signature-type">string</span></div>
|
||||
<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/dcfbd23/docs/index.d.ts#L103">index.d.ts:103</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L112">index.d.ts:112</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@ -191,6 +191,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>HttpRequest | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>HttpRequest | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -102,13 +102,13 @@
|
||||
<a name="getheader" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Header</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Header<span class="tsd-signature-symbol">(</span>lowerCaseKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Header<span class="tsd-signature-symbol">(</span>lowerCaseKey<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">string</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/dcfbd23/docs/index.d.ts#L70">index.d.ts:70</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L79">index.d.ts:79</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -119,7 +119,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>lowerCaseKey: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>lowerCaseKey: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
@ -136,7 +136,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L76">index.d.ts:76</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L85">index.d.ts:85</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/dcfbd23/docs/index.d.ts#L72">index.d.ts:72</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L81">index.d.ts:81</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/dcfbd23/docs/index.d.ts#L78">index.d.ts:78</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L87">index.d.ts:87</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/dcfbd23/docs/index.d.ts#L74">index.d.ts:74</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L83">index.d.ts:83</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -277,6 +277,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>HttpResponse | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>HttpResponse | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -88,6 +88,7 @@
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#end" class="tsd-kind-icon">end</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#onaborted" class="tsd-kind-icon">on<wbr>Aborted</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#ondata" class="tsd-kind-icon">on<wbr>Data</a></li>
|
||||
@ -113,7 +114,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L46">index.d.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L52">index.d.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -129,13 +130,13 @@
|
||||
<a name="end" class="tsd-anchor"></a>
|
||||
<h3>end</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>body<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-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>body<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="httpresponse.html" class="tsd-signature-type">HttpResponse</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/dcfbd23/docs/index.d.ts#L41">index.d.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L47">index.d.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -146,13 +147,35 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>body: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>body: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="getremoteaddress" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Remote<wbr>Address</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Remote<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L73">index.d.ts:73</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the remote IP address</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="getwriteoffset" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Write<wbr>Offset</h3>
|
||||
@ -163,7 +186,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L49">index.d.ts:49</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L55">index.d.ts:55</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -185,7 +208,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L61">index.d.ts:61</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L67">index.d.ts:67</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -234,7 +257,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L64">index.d.ts:64</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L70">index.d.ts:70</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -286,7 +309,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L55">index.d.ts:55</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L61">index.d.ts:61</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -328,13 +351,13 @@
|
||||
<a name="tryend" class="tsd-anchor"></a>
|
||||
<h3>try<wbr>End</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">try<wbr>End<span class="tsd-signature-symbol">(</span>fullBodyOrChunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, totalSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">try<wbr>End<span class="tsd-signature-symbol">(</span>fullBodyOrChunk<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, totalSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</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/dcfbd23/docs/index.d.ts#L43">index.d.ts:43</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L49">index.d.ts:49</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -345,7 +368,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>fullBodyOrChunk: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>fullBodyOrChunk: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>totalSize: <span class="tsd-signature-type">number</span></h5>
|
||||
@ -359,13 +382,13 @@
|
||||
<a name="write" class="tsd-anchor"></a>
|
||||
<h3>write</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>chunk<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-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>chunk<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="httpresponse.html" class="tsd-signature-type">HttpResponse</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/dcfbd23/docs/index.d.ts#L39">index.d.ts:39</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L45">index.d.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -376,7 +399,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>chunk: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>chunk: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h4>
|
||||
@ -387,13 +410,13 @@
|
||||
<a name="writeheader" class="tsd-anchor"></a>
|
||||
<h3>write<wbr>Header</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">write<wbr>Header<span class="tsd-signature-symbol">(</span>key<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>, value<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-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">write<wbr>Header<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, value<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="httpresponse.html" class="tsd-signature-type">HttpResponse</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/dcfbd23/docs/index.d.ts#L37">index.d.ts:37</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L43">index.d.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -404,10 +427,10 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>key: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>value: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h4>
|
||||
@ -418,13 +441,13 @@
|
||||
<a name="writestatus" class="tsd-anchor"></a>
|
||||
<h3>write<wbr>Status</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">write<wbr>Status<span class="tsd-signature-symbol">(</span>status<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-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">write<wbr>Status<span class="tsd-signature-symbol">(</span>status<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="httpresponse.html" class="tsd-signature-type">HttpResponse</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/dcfbd23/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L41">index.d.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -435,7 +458,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>status: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>status: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h4>
|
||||
@ -474,6 +497,9 @@
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="httpresponse.html#end" class="tsd-kind-icon">end</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a>
|
||||
</li>
|
||||
@ -514,6 +540,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TemplatedApp | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>TemplatedApp | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -109,13 +109,13 @@
|
||||
<a name="any" class="tsd-anchor"></a>
|
||||
<h3>any</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">any<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">any<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L132">index.d.ts:132</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L141">index.d.ts:141</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -126,7 +126,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -161,13 +161,13 @@
|
||||
<a name="connect" class="tsd-anchor"></a>
|
||||
<h3>connect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L128">index.d.ts:128</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L137">index.d.ts:137</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -178,7 +178,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -213,13 +213,13 @@
|
||||
<a name="del" class="tsd-anchor"></a>
|
||||
<h3>del</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L120">index.d.ts:120</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L129">index.d.ts:129</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -230,7 +230,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -265,13 +265,13 @@
|
||||
<a name="get" class="tsd-anchor"></a>
|
||||
<h3>get</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L114">index.d.ts:114</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L123">index.d.ts:123</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -282,7 +282,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -317,13 +317,13 @@
|
||||
<a name="head" class="tsd-anchor"></a>
|
||||
<h3>head</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L126">index.d.ts:126</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L135">index.d.ts:135</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -334,7 +334,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -369,14 +369,14 @@
|
||||
<a name="listen" class="tsd-anchor"></a>
|
||||
<h3>listen</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L110">index.d.ts:110</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L119">index.d.ts:119</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -387,7 +387,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>host: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>host: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
||||
@ -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/dcfbd23/docs/index.d.ts#L112">index.d.ts:112</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L121">index.d.ts:121</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -462,13 +462,13 @@
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>options</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L118">index.d.ts:118</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L127">index.d.ts:127</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -479,7 +479,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -514,13 +514,13 @@
|
||||
<a name="patch" class="tsd-anchor"></a>
|
||||
<h3>patch</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L122">index.d.ts:122</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L131">index.d.ts:131</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -531,7 +531,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -566,13 +566,13 @@
|
||||
<a name="post" class="tsd-anchor"></a>
|
||||
<h3>post</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L116">index.d.ts:116</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L125">index.d.ts:125</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -583,7 +583,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -618,13 +618,13 @@
|
||||
<a name="put" class="tsd-anchor"></a>
|
||||
<h3>put</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L124">index.d.ts:124</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L133">index.d.ts:133</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -635,7 +635,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -670,13 +670,13 @@
|
||||
<a name="trace" class="tsd-anchor"></a>
|
||||
<h3>trace</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">trace<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">trace<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<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><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L130">index.d.ts:130</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L139">index.d.ts:139</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -687,7 +687,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||||
@ -722,13 +722,13 @@
|
||||
<a name="ws" class="tsd-anchor"></a>
|
||||
<h3>ws</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, behavior<span class="tsd-signature-symbol">: </span><a href="websocketbehavior.html" class="tsd-signature-type">WebSocketBehavior</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, behavior<span class="tsd-signature-symbol">: </span><a href="websocketbehavior.html" class="tsd-signature-type">WebSocketBehavior</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</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/dcfbd23/docs/index.d.ts#L134">index.d.ts:134</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L143">index.d.ts:143</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -739,7 +739,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
||||
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>behavior: <a href="websocketbehavior.html" class="tsd-signature-type">WebSocketBehavior</a></h5>
|
||||
@ -827,6 +827,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -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.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>us_listen_socket | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -118,6 +118,9 @@
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>WebSocket | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>WebSocket | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -89,6 +89,7 @@
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#end" class="tsd-kind-icon">end</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><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 tsd-is-not-exported"><a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#publish" class="tsd-kind-icon">publish</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#send" class="tsd-kind-icon">send</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
|
||||
@ -110,7 +111,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -126,13 +127,13 @@
|
||||
<a name="end" class="tsd-anchor"></a>
|
||||
<h3>end</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, shortMessage<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-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, shortMessage<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>
|
||||
</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/dcfbd23/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -146,7 +147,7 @@
|
||||
<h5>code: <span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>shortMessage: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>shortMessage: <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>
|
||||
@ -163,7 +164,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -176,16 +177,38 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="publish" class="tsd-anchor"></a>
|
||||
<h3>publish</h3>
|
||||
<a name="getremoteaddress" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Remote<wbr>Address</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span>, message<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-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Remote<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the remote IP address</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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>
|
||||
</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/3ce5d37/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -196,10 +219,10 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>topic: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>topic: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>message: <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>
|
||||
@ -210,13 +233,13 @@
|
||||
<a name="send" class="tsd-anchor"></a>
|
||||
<h3>send</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>message<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>, 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><span class="tsd-signature-type">boolean</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>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><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/dcfbd23/docs/index.d.ts#L11">index.d.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -227,7 +250,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<h5>message: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>isBinary: <span class="tsd-signature-type">boolean</span></h5>
|
||||
@ -244,13 +267,13 @@
|
||||
<a name="subscribe" class="tsd-anchor"></a>
|
||||
<h3>subscribe</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>topic<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-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<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>
|
||||
</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/dcfbd23/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -261,7 +284,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>topic: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<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>
|
||||
@ -272,13 +295,13 @@
|
||||
<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><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-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><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/dcfbd23/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L32">index.d.ts:32</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -289,7 +312,7 @@
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>topic: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
|
||||
<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>
|
||||
@ -337,6 +360,9 @@
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<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 tsd-is-not-exported">
|
||||
<a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a href="websocket.html#publish" class="tsd-kind-icon">publish</a>
|
||||
</li>
|
||||
@ -359,6 +385,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>WebSocketBehavior | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
||||
<title>WebSocketBehavior | uWebSockets.js v15.6.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.1.0 documentation (WIP & incomplete)</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v15.6.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
@ -106,7 +106,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/dcfbd23/docs/index.d.ts#L96">index.d.ts:96</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L105">index.d.ts:105</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -145,10 +145,10 @@
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
||||
<a name="compression" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<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/dcfbd23/docs/index.d.ts#L88">index.d.ts:88</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L97">index.d.ts:97</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -163,7 +163,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/dcfbd23/docs/index.d.ts#L94">index.d.ts:94</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L103">index.d.ts:103</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -199,7 +199,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/dcfbd23/docs/index.d.ts#L86">index.d.ts:86</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L95">index.d.ts:95</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -214,7 +214,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/dcfbd23/docs/index.d.ts#L84">index.d.ts:84</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L93">index.d.ts:93</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -229,7 +229,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/dcfbd23/docs/index.d.ts#L92">index.d.ts:92</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L101">index.d.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -271,7 +271,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/dcfbd23/docs/index.d.ts#L90">index.d.ts:90</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L99">index.d.ts:99</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@ -367,6 +367,9 @@
|
||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
||||
</li>
|
||||
|
||||
65
docs/index.d.ts
vendored
65
docs/index.d.ts
vendored
@ -5,42 +5,48 @@ interface us_listen_socket {
|
||||
|
||||
}
|
||||
|
||||
/** Recognized string types, things C++ can read and understand as strings */
|
||||
type RecognizedString = string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array;
|
||||
|
||||
/** A WebSocket connection that is valid from open to close event */
|
||||
interface WebSocket {
|
||||
/** Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given. */
|
||||
send(message: string | ArrayBuffer, isBinary: boolean, compress: boolean) : boolean;
|
||||
send(message: RecognizedString, isBinary: boolean, compress: boolean) : boolean;
|
||||
|
||||
/** Returns the bytes buffered in backpressure. */
|
||||
getBufferedAmount() : number;
|
||||
|
||||
/** Gradefully closes this WebSocket. Immediately calls close handler. */
|
||||
end(code: number, shortMessage: string | ArrayBuffer) : WebSocket;
|
||||
end(code: number, shortMessage: RecognizedString) : WebSocket;
|
||||
|
||||
/** Forefully closes this WebSocket. Immediately calls close handler. */
|
||||
close() : WebSocket;
|
||||
|
||||
/** Subscribe to a topic in MQTT syntax */
|
||||
subscribe(topic: string | ArrayBuffer) : WebSocket;
|
||||
subscribe(topic: RecognizedString) : WebSocket;
|
||||
|
||||
/** Publish a message to a topic in MQTT syntax */
|
||||
publish(topic: string | ArrayBuffer, message: string | ArrayBuffer) : WebSocket;
|
||||
publish(topic: RecognizedString, message: RecognizedString) : WebSocket;
|
||||
|
||||
/** Unsubscribe from topic (not implemented yet) */
|
||||
unsubscribe(topic: string | ArrayBuffer) : WebSocket;
|
||||
unsubscribe(topic: RecognizedString) : WebSocket;
|
||||
|
||||
/** Returns the remote IP address */
|
||||
getRemoteAddress() : ArrayBuffer;
|
||||
}
|
||||
|
||||
/** An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object. */
|
||||
interface HttpResponse {
|
||||
/** Writes the HTTP status message such as "200 OK". */
|
||||
writeStatus(status: string | ArrayBuffer) : HttpResponse;
|
||||
writeStatus(status: RecognizedString) : HttpResponse;
|
||||
/** Writes key and value to HTTP response. */
|
||||
writeHeader(key: string | ArrayBuffer, value: string | ArrayBuffer) : HttpResponse;
|
||||
writeHeader(key: RecognizedString, value: RecognizedString) : HttpResponse;
|
||||
/** Enters or continues chunked encoding mode. Writes part of the response. End with zero length write. */
|
||||
write(chunk: string | ArrayBuffer) : HttpResponse;
|
||||
write(chunk: RecognizedString) : HttpResponse;
|
||||
/** Ends this response by copying the contents of body. */
|
||||
end(body: string | ArrayBuffer) : HttpResponse;
|
||||
end(body: RecognizedString) : HttpResponse;
|
||||
/** Ends this response, or tries to, by streaming appropriately sized chunks of body. Use in conjunction with onWritable. Returns tuple [ok, hasResponded].*/
|
||||
tryEnd(fullBodyOrChunk: string, totalSize: number) : [boolean, boolean];
|
||||
tryEnd(fullBodyOrChunk: RecognizedString, totalSize: number) : [boolean, boolean];
|
||||
|
||||
/** Immediately force closes the connection. */
|
||||
close() : HttpResponse;
|
||||
@ -62,12 +68,15 @@ interface HttpResponse {
|
||||
|
||||
/** Handler for reading data from POST and such requests. You MUST copy the data of chunk if isLast is not true. We Neuter ArrayBuffers on return, making it zero length.*/
|
||||
onData(handler: (res: HttpResponse, chunk: ArrayBuffer, isLast: boolean) => void) : HttpResponse;
|
||||
|
||||
/** Returns the remote IP address */
|
||||
getRemoteAddress() : ArrayBuffer;
|
||||
}
|
||||
|
||||
/** An HttpRequest is stack allocated and only accessible during the callback invocation. */
|
||||
interface HttpRequest {
|
||||
/** Returns the lowercased header value or empty string. */
|
||||
getHeader(lowerCaseKey: string) : string;
|
||||
getHeader(lowerCaseKey: RecognizedString) : string;
|
||||
/** Returns the parsed parameter at index. Corresponds to route. */
|
||||
getParameter(index: number) : string;
|
||||
/** Returns the URL including initial /slash */
|
||||
@ -85,7 +94,7 @@ interface WebSocketBehavior {
|
||||
/** Maximum amount of seconds that may pass without sending or getting a message. */
|
||||
idleTimeout?: number;
|
||||
/** 0 = no compression, 1 = shared compressor, 2 = dedicated compressor. See C++ project. */
|
||||
compression?: number;
|
||||
compression?: CompressOptions;
|
||||
/** 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. */
|
||||
@ -98,40 +107,40 @@ interface WebSocketBehavior {
|
||||
|
||||
/** Options used when constructing an app. */
|
||||
interface AppOptions {
|
||||
key_file_name?: string;
|
||||
cert_file_name?: string;
|
||||
passphrase?: string;
|
||||
dh_params_file_name?: string;
|
||||
key_file_name?: RecognizedString;
|
||||
cert_file_name?: RecognizedString;
|
||||
passphrase?: RecognizedString;
|
||||
dh_params_file_name?: RecognizedString;
|
||||
}
|
||||
|
||||
/** TemplatedApp is either an SSL or non-SSL app. */
|
||||
interface TemplatedApp {
|
||||
/** Listens to hostname & port. Callback hands either false or a listen socket. */
|
||||
listen(host: string, port: number, cb: (listenSocket: us_listen_socket) => void): TemplatedApp;
|
||||
listen(host: RecognizedString, port: number, cb: (listenSocket: us_listen_socket) => void): TemplatedApp;
|
||||
/** Listens to port. Callback hands either false or a listen socket. */
|
||||
listen(port: number, cb: (listenSocket: any) => void): TemplatedApp;
|
||||
/** Registers an HTTP GET handler matching specified URL pattern. */
|
||||
get(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
get(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP POST handler matching specified URL pattern. */
|
||||
post(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP OPTIONS handler matching specified URL pattern. */
|
||||
options(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP DELETE handler matching specified URL pattern. */
|
||||
del(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
del(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP PATCH handler matching specified URL pattern. */
|
||||
patch(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP PUT handler matching specified URL pattern. */
|
||||
put(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP HEAD handler matching specified URL pattern. */
|
||||
head(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
head(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP CONNECT handler matching specified URL pattern. */
|
||||
connect(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
connect(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP TRACE handler matching specified URL pattern. */
|
||||
trace(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers an HTTP handler matching specified URL pattern on any HTTP method. */
|
||||
any(pattern: string, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
any(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
|
||||
/** Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught. */
|
||||
ws(pattern: string, behavior: WebSocketBehavior) : TemplatedApp;
|
||||
ws(pattern: RecognizedString, behavior: WebSocketBehavior) : TemplatedApp;
|
||||
}
|
||||
|
||||
/** Constructs a non-SSL app */
|
||||
|
||||
Loading…
Reference in New Issue
Block a user