Update docs
This commit is contained in:
parent
0526685633
commit
903dc89240
@ -1,2 +1,2 @@
|
|||||||
default:
|
default:
|
||||||
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v16.3.0 documentation" --mode file --readme none .
|
typedoc --out generated --includeDeclarations --excludeExternals --name "uWebSockets.js v16.5.0 documentation" --mode file --readme none .
|
||||||
|
2
docs/generated/assets/js/search.js
vendored
2
docs/generated/assets/js/search.js
vendored
File diff suppressed because one or more lines are too long
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>uWebSockets.js v16.3.0 documentation</title>
|
<title>uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="assets/css/main.css">
|
<link rel="stylesheet" href="assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -54,7 +54,7 @@
|
|||||||
<a href="index.html">Globals</a>
|
<a href="index.html">Globals</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h1> uWebSockets.js v16.3.0 documentation</h1>
|
<h1> uWebSockets.js v16.5.0 documentation</h1>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
@ -65,23 +65,23 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Interfaces</h3>
|
<h3>Interfaces</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a></li>
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a></li>
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a></li>
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a></li>
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a></li>
|
||||||
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a></li>
|
<li class="tsd-kind-interface"><a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a></li>
|
||||||
<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-interface"><a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-index-section ">
|
<section class="tsd-index-section ">
|
||||||
<h3>Type aliases</h3>
|
<h3>Type aliases</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-type-alias"><a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a></li>
|
<li class="tsd-kind-type-alias"><a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a></li>
|
||||||
<li class="tsd-kind-type-alias tsd-is-not-exported"><a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a></li>
|
<li class="tsd-kind-type-alias"><a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-index-section ">
|
<section class="tsd-index-section ">
|
||||||
@ -111,7 +111,7 @@
|
|||||||
<div class="tsd-signature tsd-kind-icon">Compress<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
<div class="tsd-signature tsd-kind-icon">Compress<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L170">index.d.ts:170</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L187">index.d.ts:187</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -120,13 +120,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
||||||
<a name="recognizedstring" class="tsd-anchor"></a>
|
<a name="recognizedstring" class="tsd-anchor"></a>
|
||||||
<h3>Recognized<wbr>String</h3>
|
<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>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L9">index.d.ts:9</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L9">index.d.ts:9</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -144,7 +144,7 @@
|
|||||||
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
<div class="tsd-signature tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L176">index.d.ts:176</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L193">index.d.ts:193</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -159,7 +159,7 @@
|
|||||||
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
<div class="tsd-signature tsd-kind-icon">DISABLED<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L172">index.d.ts:172</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L189">index.d.ts:189</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -174,7 +174,7 @@
|
|||||||
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
<div class="tsd-signature tsd-kind-icon">SHARED_<wbr>COMPRESSOR<span class="tsd-signature-symbol">:</span> <a href="index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L174">index.d.ts:174</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L191">index.d.ts:191</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -196,7 +196,7 @@
|
|||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L161">index.d.ts:161</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L178">index.d.ts:178</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -224,7 +224,7 @@
|
|||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L164">index.d.ts:164</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L181">index.d.ts:181</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -252,7 +252,7 @@
|
|||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L167">index.d.ts:167</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L184">index.d.ts:184</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -282,31 +282,31 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="interfaces/appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="interfaces/httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="interfaces/httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="interfaces/templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="interfaces/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="interfaces/websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="interfaces/us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>AppOptions | uWebSockets.js v16.3.0 documentation</title>
|
<title>AppOptions | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -83,68 +83,68 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Properties</h3>
|
<h3>Properties</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Properties</h2>
|
<h2>Properties</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="cert_file_name" class="tsd-anchor"></a>
|
<a name="cert_file_name" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cert_<wbr>file_<wbr>name</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cert_<wbr>file_<wbr>name</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
<div class="tsd-signature tsd-kind-icon">cert_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L121">index.d.ts:121</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L138">index.d.ts:138</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="dh_params_file_name" class="tsd-anchor"></a>
|
<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>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dh_<wbr>params_<wbr>file_<wbr>name</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
<div class="tsd-signature tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L123">index.d.ts:123</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L140">index.d.ts:140</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="key_file_name" class="tsd-anchor"></a>
|
<a name="key_file_name" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> key_<wbr>file_<wbr>name</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> key_<wbr>file_<wbr>name</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
<div class="tsd-signature tsd-kind-icon">key_<wbr>file_<wbr>name<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L120">index.d.ts:120</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L137">index.d.ts:137</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="passphrase" class="tsd-anchor"></a>
|
<a name="passphrase" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> passphrase</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> passphrase</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
<div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">:</span> <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L122">index.d.ts:122</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L139">index.d.ts:139</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="ssl_prefer_low_memory_usage" class="tsd-anchor"></a>
|
<a name="ssl_prefer_low_memory_usage" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
<div class="tsd-signature tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L125">index.d.ts:125</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L142">index.d.ts:142</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -167,50 +167,50 @@
|
|||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a>
|
<a href="appoptions.html#cert_file_name" class="tsd-kind-icon">cert_<wbr>file_<wbr>name</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a>
|
<a href="appoptions.html#dh_params_file_name" class="tsd-kind-icon">dh_<wbr>params_<wbr>file_<wbr>name</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a>
|
<a href="appoptions.html#key_file_name" class="tsd-kind-icon">key_<wbr>file_<wbr>name</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a>
|
<a href="appoptions.html#passphrase" class="tsd-kind-icon">passphrase</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a>
|
<a href="appoptions.html#ssl_prefer_low_memory_usage" class="tsd-kind-icon">ssl_<wbr>prefer_<wbr>low_<wbr>memory_<wbr>usage</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>HttpRequest | uWebSockets.js v16.3.0 documentation</title>
|
<title>HttpRequest | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -83,33 +83,34 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Methods</h3>
|
<h3>Methods</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httprequest.html#setyield" class="tsd-kind-icon">set<wbr>Yield</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Methods</h2>
|
<h2>Methods</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="foreach" class="tsd-anchor"></a>
|
<a name="foreach" class="tsd-anchor"></a>
|
||||||
<h3>for<wbr>Each</h3>
|
<h3>for<wbr>Each</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L95">index.d.ts:95</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L110">index.d.ts:110</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -148,17 +149,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getheader" class="tsd-anchor"></a>
|
<a name="getheader" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Header</h3>
|
<h3>get<wbr>Header</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L85">index.d.ts:85</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L100">index.d.ts:100</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -176,17 +177,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getmethod" class="tsd-anchor"></a>
|
<a name="getmethod" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Method</h3>
|
<h3>get<wbr>Method</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Method<span class="tsd-signature-symbol">(</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>Method<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L91">index.d.ts:91</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L106">index.d.ts:106</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -198,17 +199,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getparameter" class="tsd-anchor"></a>
|
<a name="getparameter" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Parameter</h3>
|
<h3>get<wbr>Parameter</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Parameter<span class="tsd-signature-symbol">(</span>index<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-type">string</span></li>
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Parameter<span class="tsd-signature-symbol">(</span>index<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-type">string</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L87">index.d.ts:87</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L102">index.d.ts:102</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -226,17 +227,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getquery" class="tsd-anchor"></a>
|
<a name="getquery" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Query</h3>
|
<h3>get<wbr>Query</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Query<span class="tsd-signature-symbol">(</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>Query<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L93">index.d.ts:93</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L108">index.d.ts:108</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -248,17 +249,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="geturl" class="tsd-anchor"></a>
|
<a name="geturl" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Url</h3>
|
<h3>get<wbr>Url</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Url<span class="tsd-signature-symbol">(</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>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L89">index.d.ts:89</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L104">index.d.ts:104</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -270,6 +271,34 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<a name="setyield" class="tsd-anchor"></a>
|
||||||
|
<h3>set<wbr>Yield</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Yield<span class="tsd-signature-symbol">(</span>yield<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</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/0526685/docs/index.d.ts#L112">index.d.ts:112</a></li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>yield: <span class="tsd-signature-type">boolean</span></h5>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||||
@ -282,55 +311,58 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a>
|
<a href="httprequest.html#foreach" class="tsd-kind-icon">for<wbr>Each</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a>
|
<a href="httprequest.html#getheader" class="tsd-kind-icon">get<wbr>Header</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a>
|
<a href="httprequest.html#getmethod" class="tsd-kind-icon">get<wbr>Method</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a>
|
<a href="httprequest.html#getparameter" class="tsd-kind-icon">get<wbr>Parameter</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a>
|
<a href="httprequest.html#getquery" class="tsd-kind-icon">get<wbr>Query</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a>
|
<a href="httprequest.html#geturl" class="tsd-kind-icon">get<wbr>Url</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<a href="httprequest.html#setyield" class="tsd-kind-icon">set<wbr>Yield</a>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>HttpResponse | uWebSockets.js v16.3.0 documentation</title>
|
<title>HttpResponse | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -79,7 +79,7 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-kind-interface">
|
||||||
<h3 class="tsd-before-signature">Indexable</h3>
|
<h3 class="tsd-before-signature">Indexable</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
|
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -92,38 +92,39 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Methods</h3>
|
<h3>Methods</h3>
|
||||||
<ul class="tsd-index-list">
|
<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"><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"><a href="httpresponse.html#cork" class="tsd-kind-icon">cork</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"><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#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><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#onaborted" class="tsd-kind-icon">on<wbr>Aborted</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><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#ondata" class="tsd-kind-icon">on<wbr>Data</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><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#onwritable" class="tsd-kind-icon">on<wbr>Writable</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#ondata" class="tsd-kind-icon">on<wbr>Data</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#onwritable" class="tsd-kind-icon">on<wbr>Writable</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#write" class="tsd-kind-icon">write</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#writeheader" class="tsd-kind-icon">write<wbr>Header</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#write" class="tsd-kind-icon">write</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="httpresponse.html#writestatus" class="tsd-kind-icon">write<wbr>Status</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#writeheader" class="tsd-kind-icon">write<wbr>Header</a></li>
|
||||||
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="httpresponse.html#writestatus" class="tsd-kind-icon">write<wbr>Status</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Methods</h2>
|
<h2>Methods</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="close" class="tsd-anchor"></a>
|
<a name="close" class="tsd-anchor"></a>
|
||||||
<h3>close</h3>
|
<h3>close</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</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">close<span class="tsd-signature-symbol">(</span><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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L55">index.d.ts:55</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L55">index.d.ts:55</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -135,17 +136,66 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<a name="cork" class="tsd-anchor"></a>
|
||||||
|
<h3>cork</h3>
|
||||||
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<li class="tsd-signature tsd-kind-icon">cork<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<aside class="tsd-sources">
|
||||||
|
<ul>
|
||||||
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L91">index.d.ts:91</a></li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
<div class="tsd-comment tsd-typography">
|
||||||
|
<div class="lead">
|
||||||
|
<p>Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once.
|
||||||
|
By default, you're corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from
|
||||||
|
await, or when being called back from an async database request or anything that isn't directly executing in the route handler, you'll want
|
||||||
|
to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and
|
||||||
|
such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result
|
||||||
|
in one TLS block being sent off, each with one send syscall.</p>
|
||||||
|
</div>
|
||||||
|
<p>Example usage:</p>
|
||||||
|
<p>res.cork(() => {
|
||||||
|
res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!");
|
||||||
|
});</p>
|
||||||
|
</div>
|
||||||
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li>
|
||||||
|
<h5>cb: <span class="tsd-signature-type">function</span></h5>
|
||||||
|
<ul class="tsd-parameters">
|
||||||
|
<li class="tsd-parameter-siganture">
|
||||||
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||||||
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||||
|
</ul>
|
||||||
|
<ul class="tsd-descriptions">
|
||||||
|
<li class="tsd-description">
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="end" class="tsd-anchor"></a>
|
<a name="end" class="tsd-anchor"></a>
|
||||||
<h3>end</h3>
|
<h3>end</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L50">index.d.ts:50</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L50">index.d.ts:50</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -163,17 +213,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getremoteaddress" class="tsd-anchor"></a>
|
<a name="getremoteaddress" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Remote<wbr>Address</h3>
|
<h3>get<wbr>Remote<wbr>Address</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L76">index.d.ts:76</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L76">index.d.ts:76</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -185,17 +235,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getwriteoffset" class="tsd-anchor"></a>
|
<a name="getwriteoffset" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Write<wbr>Offset</h3>
|
<h3>get<wbr>Write<wbr>Offset</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Write<wbr>Offset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Write<wbr>Offset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L58">index.d.ts:58</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L58">index.d.ts:58</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -207,17 +257,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="onaborted" class="tsd-anchor"></a>
|
<a name="onaborted" class="tsd-anchor"></a>
|
||||||
<h3>on<wbr>Aborted</h3>
|
<h3>on<wbr>Aborted</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">on<wbr>Aborted<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Aborted<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L70">index.d.ts:70</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L70">index.d.ts:70</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -250,17 +300,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="ondata" class="tsd-anchor"></a>
|
<a name="ondata" class="tsd-anchor"></a>
|
||||||
<h3>on<wbr>Data</h3>
|
<h3>on<wbr>Data</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">on<wbr>Data<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Data<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L73">index.d.ts:73</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L73">index.d.ts:73</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -299,17 +349,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="onwritable" class="tsd-anchor"></a>
|
<a name="onwritable" class="tsd-anchor"></a>
|
||||||
<h3>on<wbr>Writable</h3>
|
<h3>on<wbr>Writable</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">on<wbr>Writable<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Writable<span class="tsd-signature-symbol">(</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="httpresponse.html" class="tsd-signature-type">HttpResponse</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L64">index.d.ts:64</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L64">index.d.ts:64</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -347,17 +397,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="tryend" class="tsd-anchor"></a>
|
<a name="tryend" class="tsd-anchor"></a>
|
||||||
<h3>try<wbr>End</h3>
|
<h3>try<wbr>End</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L52">index.d.ts:52</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L52">index.d.ts:52</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -378,17 +428,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="write" class="tsd-anchor"></a>
|
<a name="write" class="tsd-anchor"></a>
|
||||||
<h3>write</h3>
|
<h3>write</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L48">index.d.ts:48</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L48">index.d.ts:48</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -406,17 +456,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="writeheader" class="tsd-anchor"></a>
|
<a name="writeheader" class="tsd-anchor"></a>
|
||||||
<h3>write<wbr>Header</h3>
|
<h3>write<wbr>Header</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L46">index.d.ts:46</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L46">index.d.ts:46</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -437,17 +487,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="writestatus" class="tsd-anchor"></a>
|
<a name="writestatus" class="tsd-anchor"></a>
|
||||||
<h3>write<wbr>Status</h3>
|
<h3>write<wbr>Status</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L44">index.d.ts:44</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L44">index.d.ts:44</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -477,70 +527,73 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#close" class="tsd-kind-icon">close</a>
|
<a href="httpresponse.html#close" class="tsd-kind-icon">close</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
|
<a href="httpresponse.html#cork" class="tsd-kind-icon">cork</a>
|
||||||
|
</li>
|
||||||
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#end" class="tsd-kind-icon">end</a>
|
<a href="httpresponse.html#end" class="tsd-kind-icon">end</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
<a href="httpresponse.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a>
|
<a href="httpresponse.html#getwriteoffset" class="tsd-kind-icon">get<wbr>Write<wbr>Offset</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#onaborted" class="tsd-kind-icon">on<wbr>Aborted</a>
|
<a href="httpresponse.html#onaborted" class="tsd-kind-icon">on<wbr>Aborted</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#ondata" class="tsd-kind-icon">on<wbr>Data</a>
|
<a href="httpresponse.html#ondata" class="tsd-kind-icon">on<wbr>Data</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#onwritable" class="tsd-kind-icon">on<wbr>Writable</a>
|
<a href="httpresponse.html#onwritable" class="tsd-kind-icon">on<wbr>Writable</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a>
|
<a href="httpresponse.html#tryend" class="tsd-kind-icon">try<wbr>End</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#write" class="tsd-kind-icon">write</a>
|
<a href="httpresponse.html#write" class="tsd-kind-icon">write</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#writeheader" class="tsd-kind-icon">write<wbr>Header</a>
|
<a href="httpresponse.html#writeheader" class="tsd-kind-icon">write<wbr>Header</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="httpresponse.html#writestatus" class="tsd-kind-icon">write<wbr>Status</a>
|
<a href="httpresponse.html#writestatus" class="tsd-kind-icon">write<wbr>Status</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>TemplatedApp | uWebSockets.js v16.3.0 documentation</title>
|
<title>TemplatedApp | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -83,40 +83,40 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Methods</h3>
|
<h3>Methods</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#any" class="tsd-kind-icon">any</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#any" class="tsd-kind-icon">any</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#del" class="tsd-kind-icon">del</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#del" class="tsd-kind-icon">del</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#get" class="tsd-kind-icon">get</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#get" class="tsd-kind-icon">get</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#head" class="tsd-kind-icon">head</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#head" class="tsd-kind-icon">head</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#options" class="tsd-kind-icon">options</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#options" class="tsd-kind-icon">options</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#post" class="tsd-kind-icon">post</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#post" class="tsd-kind-icon">post</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#put" class="tsd-kind-icon">put</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#put" class="tsd-kind-icon">put</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Methods</h2>
|
<h2>Methods</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="any" class="tsd-anchor"></a>
|
<a name="any" class="tsd-anchor"></a>
|
||||||
<h3>any</h3>
|
<h3>any</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L153">index.d.ts:153</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L170">index.d.ts:170</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -158,17 +158,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="connect" class="tsd-anchor"></a>
|
<a name="connect" class="tsd-anchor"></a>
|
||||||
<h3>connect</h3>
|
<h3>connect</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L149">index.d.ts:149</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L166">index.d.ts:166</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -210,17 +210,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="del" class="tsd-anchor"></a>
|
<a name="del" class="tsd-anchor"></a>
|
||||||
<h3>del</h3>
|
<h3>del</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L141">index.d.ts:141</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L158">index.d.ts:158</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -262,17 +262,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="get" class="tsd-anchor"></a>
|
<a name="get" class="tsd-anchor"></a>
|
||||||
<h3>get</h3>
|
<h3>get</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L135">index.d.ts:135</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L152">index.d.ts:152</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -314,17 +314,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="head" class="tsd-anchor"></a>
|
<a name="head" class="tsd-anchor"></a>
|
||||||
<h3>head</h3>
|
<h3>head</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L147">index.d.ts:147</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L164">index.d.ts:164</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -366,10 +366,10 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="listen" class="tsd-anchor"></a>
|
<a name="listen" class="tsd-anchor"></a>
|
||||||
<h3>listen</h3>
|
<h3>listen</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>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>
|
<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>
|
||||||
@ -377,7 +377,7 @@
|
|||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L131">index.d.ts:131</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L148">index.d.ts:148</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -420,7 +420,7 @@
|
|||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L133">index.d.ts:133</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L150">index.d.ts:150</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -459,17 +459,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="options" class="tsd-anchor"></a>
|
<a name="options" class="tsd-anchor"></a>
|
||||||
<h3>options</h3>
|
<h3>options</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L139">index.d.ts:139</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L156">index.d.ts:156</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -511,17 +511,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="patch" class="tsd-anchor"></a>
|
<a name="patch" class="tsd-anchor"></a>
|
||||||
<h3>patch</h3>
|
<h3>patch</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L143">index.d.ts:143</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L160">index.d.ts:160</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -563,17 +563,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="post" class="tsd-anchor"></a>
|
<a name="post" class="tsd-anchor"></a>
|
||||||
<h3>post</h3>
|
<h3>post</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L137">index.d.ts:137</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L154">index.d.ts:154</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -615,17 +615,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="publish" class="tsd-anchor"></a>
|
<a name="publish" class="tsd-anchor"></a>
|
||||||
<h3>publish</h3>
|
<h3>publish</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L157">index.d.ts:157</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L174">index.d.ts:174</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -652,17 +652,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="put" class="tsd-anchor"></a>
|
<a name="put" class="tsd-anchor"></a>
|
||||||
<h3>put</h3>
|
<h3>put</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L145">index.d.ts:145</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L162">index.d.ts:162</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -704,17 +704,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="trace" class="tsd-anchor"></a>
|
<a name="trace" class="tsd-anchor"></a>
|
||||||
<h3>trace</h3>
|
<h3>trace</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L151">index.d.ts:151</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L168">index.d.ts:168</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -756,17 +756,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="ws" class="tsd-anchor"></a>
|
<a name="ws" class="tsd-anchor"></a>
|
||||||
<h3>ws</h3>
|
<h3>ws</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L155">index.d.ts:155</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L172">index.d.ts:172</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -799,76 +799,76 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#any" class="tsd-kind-icon">any</a>
|
<a href="templatedapp.html#any" class="tsd-kind-icon">any</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a>
|
<a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#del" class="tsd-kind-icon">del</a>
|
<a href="templatedapp.html#del" class="tsd-kind-icon">del</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#get" class="tsd-kind-icon">get</a>
|
<a href="templatedapp.html#get" class="tsd-kind-icon">get</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#head" class="tsd-kind-icon">head</a>
|
<a href="templatedapp.html#head" class="tsd-kind-icon">head</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a>
|
<a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#options" class="tsd-kind-icon">options</a>
|
<a href="templatedapp.html#options" class="tsd-kind-icon">options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a>
|
<a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#post" class="tsd-kind-icon">post</a>
|
<a href="templatedapp.html#post" class="tsd-kind-icon">post</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a>
|
<a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#put" class="tsd-kind-icon">put</a>
|
<a href="templatedapp.html#put" class="tsd-kind-icon">put</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a>
|
<a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a>
|
<a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>us_listen_socket | uWebSockets.js v16.3.0 documentation</title>
|
<title>us_listen_socket | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -90,27 +90,27 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -118,7 +118,7 @@
|
|||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>WebSocket | uWebSockets.js v16.3.0 documentation</title>
|
<title>WebSocket | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -79,7 +79,7 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-kind-interface">
|
||||||
<h3 class="tsd-before-signature">Indexable</h3>
|
<h3 class="tsd-before-signature">Indexable</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
|
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -92,62 +92,62 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Methods</h3>
|
<h3>Methods</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<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"><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"><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"><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"><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"><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"><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>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
|
||||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li>
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Methods</h2>
|
<h2>Methods</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="close" class="tsd-anchor"></a>
|
<a name="close" class="tsd-anchor"></a>
|
||||||
<h3>close</h3>
|
<h3>close</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</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">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
<div class="lead">
|
<div class="lead">
|
||||||
<p>Forefully closes this WebSocket. Immediately calls close handler.</p>
|
<p>Forcefully closes this WebSocket</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<h4 class="tsd-returns-title">Returns <a href="websocket.html" class="tsd-signature-type">WebSocket</a></h4>
|
<h4 class="tsd-returns-title">Returns <a href="websocket.html" class="tsd-signature-type">WebSocket</a></h4>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="end" class="tsd-anchor"></a>
|
<a name="end" class="tsd-anchor"></a>
|
||||||
<h3>end</h3>
|
<h3>end</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
<div class="lead">
|
<div class="lead">
|
||||||
<p>Gradefully closes this WebSocket. Immediately calls close handler.</p>
|
<p>Gracefully closes this WebSocket. Immediately calls close handler.</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||||
@ -163,17 +163,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getbufferedamount" class="tsd-anchor"></a>
|
<a name="getbufferedamount" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Buffered<wbr>Amount</h3>
|
<h3>get<wbr>Buffered<wbr>Amount</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Buffered<wbr>Amount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Buffered<wbr>Amount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -185,17 +185,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="getremoteaddress" class="tsd-anchor"></a>
|
<a name="getremoteaddress" class="tsd-anchor"></a>
|
||||||
<h3>get<wbr>Remote<wbr>Address</h3>
|
<h3>get<wbr>Remote<wbr>Address</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -207,17 +207,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="publish" class="tsd-anchor"></a>
|
<a name="publish" class="tsd-anchor"></a>
|
||||||
<h3>publish</h3>
|
<h3>publish</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="websocket.html" class="tsd-signature-type">WebSocket</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L32">index.d.ts:32</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L32">index.d.ts:32</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -244,17 +244,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="send" class="tsd-anchor"></a>
|
<a name="send" class="tsd-anchor"></a>
|
||||||
<h3>send</h3>
|
<h3>send</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -278,17 +278,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="subscribe" class="tsd-anchor"></a>
|
<a name="subscribe" class="tsd-anchor"></a>
|
||||||
<h3>subscribe</h3>
|
<h3>subscribe</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<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>
|
<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>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -306,17 +306,17 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a name="unsubscribe" class="tsd-anchor"></a>
|
<a name="unsubscribe" class="tsd-anchor"></a>
|
||||||
<h3>unsubscribe</h3>
|
<h3>unsubscribe</h3>
|
||||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||||
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="tsd-descriptions">
|
<ul class="tsd-descriptions">
|
||||||
<li class="tsd-description">
|
<li class="tsd-description">
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -346,61 +346,61 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#close" class="tsd-kind-icon">close</a>
|
<a href="websocket.html#close" class="tsd-kind-icon">close</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#end" class="tsd-kind-icon">end</a>
|
<a href="websocket.html#end" class="tsd-kind-icon">end</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#getbufferedamount" class="tsd-kind-icon">get<wbr>Buffered<wbr>Amount</a>
|
<a href="websocket.html#getbufferedamount" class="tsd-kind-icon">get<wbr>Buffered<wbr>Amount</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
<a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#publish" class="tsd-kind-icon">publish</a>
|
<a href="websocket.html#publish" class="tsd-kind-icon">publish</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#send" class="tsd-kind-icon">send</a>
|
<a href="websocket.html#send" class="tsd-kind-icon">send</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#subscribe" class="tsd-kind-icon">subscribe</a>
|
<a href="websocket.html#subscribe" class="tsd-kind-icon">subscribe</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||||
<a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a>
|
<a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<title>WebSocketBehavior | uWebSockets.js v16.3.0 documentation</title>
|
<title>WebSocketBehavior | uWebSockets.js v16.5.0 documentation</title>
|
||||||
<meta name="description" content="">
|
<meta name="description" content="">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<link rel="stylesheet" href="../assets/css/main.css">
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||||||
@ -22,7 +22,7 @@
|
|||||||
<li class="state loading">Preparing search index...</li>
|
<li class="state loading">Preparing search index...</li>
|
||||||
<li class="state failure">The search index is not available</li>
|
<li class="state failure">The search index is not available</li>
|
||||||
</ul>
|
</ul>
|
||||||
<a href="../index.html" class="title">uWebSockets.js v16.3.0 documentation</a>
|
<a href="../index.html" class="title">uWebSockets.js v16.5.0 documentation</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="table-cell" id="tsd-widgets">
|
<div class="table-cell" id="tsd-widgets">
|
||||||
<div id="tsd-filter">
|
<div id="tsd-filter">
|
||||||
@ -83,31 +83,31 @@
|
|||||||
<h2>Index</h2>
|
<h2>Index</h2>
|
||||||
<section class="tsd-panel tsd-index-panel">
|
<section class="tsd-panel tsd-index-panel">
|
||||||
<div class="tsd-index-content">
|
<div class="tsd-index-content">
|
||||||
<section class="tsd-index-section tsd-is-not-exported">
|
<section class="tsd-index-section ">
|
||||||
<h3>Properties</h3>
|
<h3>Properties</h3>
|
||||||
<ul class="tsd-index-list">
|
<ul class="tsd-index-list">
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#close" class="tsd-kind-icon">close</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#close" class="tsd-kind-icon">close</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a></li>
|
||||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a></li>
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
<section class="tsd-panel-group tsd-member-group ">
|
||||||
<h2>Properties</h2>
|
<h2>Properties</h2>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="close" class="tsd-anchor"></a>
|
<a name="close" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> close</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> close</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L115">index.d.ts:115</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L132">index.d.ts:132</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -143,13 +143,13 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="compression" class="tsd-anchor"></a>
|
<a name="compression" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
|
<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> <a href="../index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="../index.html#compressoptions" class="tsd-signature-type">CompressOptions</a></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L105">index.d.ts:105</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L122">index.d.ts:122</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -158,13 +158,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="drain" class="tsd-anchor"></a>
|
<a name="drain" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> drain</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> drain</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">drain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L113">index.d.ts:113</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L130">index.d.ts:130</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -194,13 +194,13 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="idletimeout" class="tsd-anchor"></a>
|
<a name="idletimeout" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> idle<wbr>Timeout</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> idle<wbr>Timeout</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">idle<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L103">index.d.ts:103</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L120">index.d.ts:120</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -209,13 +209,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="maxbackpressure" class="tsd-anchor"></a>
|
<a name="maxbackpressure" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Backpressure</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Backpressure</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">max<wbr>Backpressure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
<div class="tsd-signature tsd-kind-icon">max<wbr>Backpressure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||||
<aside class="tsd-sources">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L107">index.d.ts:107</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L124">index.d.ts:124</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -224,13 +224,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="maxpayloadlength" class="tsd-anchor"></a>
|
<a name="maxpayloadlength" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Payload<wbr>Length</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Payload<wbr>Length</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">max<wbr>Payload<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L101">index.d.ts:101</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L118">index.d.ts:118</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -239,13 +239,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="message" class="tsd-anchor"></a>
|
<a name="message" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> message</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> message</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L111">index.d.ts:111</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L128">index.d.ts:128</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -281,13 +281,13 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a name="open" class="tsd-anchor"></a>
|
<a name="open" class="tsd-anchor"></a>
|
||||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> open</h3>
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> open</h3>
|
||||||
<div class="tsd-signature tsd-kind-icon">open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
|
<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">
|
<aside class="tsd-sources">
|
||||||
<ul>
|
<ul>
|
||||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/5e205ad/docs/index.d.ts#L109">index.d.ts:109</a></li>
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/0526685/docs/index.d.ts#L126">index.d.ts:126</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</aside>
|
</aside>
|
||||||
<div class="tsd-comment tsd-typography">
|
<div class="tsd-comment tsd-typography">
|
||||||
@ -332,61 +332,61 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<nav class="tsd-navigation secondary menu-sticky">
|
<nav class="tsd-navigation secondary menu-sticky">
|
||||||
<ul class="before-current">
|
<ul class="before-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="current tsd-kind-interface tsd-is-not-exported">
|
<li class="current tsd-kind-interface">
|
||||||
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#close" class="tsd-kind-icon">close</a>
|
<a href="websocketbehavior.html#close" class="tsd-kind-icon">close</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a>
|
<a href="websocketbehavior.html#compression" class="tsd-kind-icon">compression</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a>
|
<a href="websocketbehavior.html#drain" class="tsd-kind-icon">drain</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a>
|
<a href="websocketbehavior.html#idletimeout" class="tsd-kind-icon">idle<wbr>Timeout</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a>
|
<a href="websocketbehavior.html#maxbackpressure" class="tsd-kind-icon">max<wbr>Backpressure</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a>
|
<a href="websocketbehavior.html#maxpayloadlength" class="tsd-kind-icon">max<wbr>Payload<wbr>Length</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a>
|
<a href="websocketbehavior.html#message" class="tsd-kind-icon">message</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||||
<a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a>
|
<a href="websocketbehavior.html#open" class="tsd-kind-icon">open</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul class="after-current">
|
<ul class="after-current">
|
||||||
<li class=" tsd-kind-interface tsd-is-not-exported">
|
<li class=" tsd-kind-interface">
|
||||||
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-type-alias tsd-is-not-exported">
|
<li class=" tsd-kind-type-alias">
|
||||||
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
||||||
</li>
|
</li>
|
||||||
<li class=" tsd-kind-variable">
|
<li class=" tsd-kind-variable">
|
||||||
|
17
docs/index.d.ts
vendored
17
docs/index.d.ts
vendored
@ -75,6 +75,21 @@ export interface HttpResponse {
|
|||||||
/** Returns the remote IP address */
|
/** Returns the remote IP address */
|
||||||
getRemoteAddress() : ArrayBuffer;
|
getRemoteAddress() : ArrayBuffer;
|
||||||
|
|
||||||
|
/** Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once.
|
||||||
|
* By default, you're corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from
|
||||||
|
* await, or when being called back from an async database request or anything that isn't directly executing in the route handler, you'll want
|
||||||
|
* to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and
|
||||||
|
* such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result
|
||||||
|
* in one TLS block being sent off, each with one send syscall.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
*
|
||||||
|
* res.cork(() => {
|
||||||
|
* res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!");
|
||||||
|
* });
|
||||||
|
*/
|
||||||
|
cork(cb: () => void) : void;
|
||||||
|
|
||||||
/** Arbitrary user data may be attached to this object */
|
/** Arbitrary user data may be attached to this object */
|
||||||
[key: string]: any;
|
[key: string]: any;
|
||||||
}
|
}
|
||||||
@ -93,6 +108,8 @@ export interface HttpRequest {
|
|||||||
getQuery() : string;
|
getQuery() : string;
|
||||||
/** Loops over all headers. */
|
/** Loops over all headers. */
|
||||||
forEach(cb: (key: string, value: string) => void) : void;
|
forEach(cb: (key: string, value: string) => void) : void;
|
||||||
|
/** Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail. */
|
||||||
|
setYield(yield: boolean) : HttpRequest;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** A structure holding settings and handlers for a WebSocket route handler. */
|
/** A structure holding settings and handlers for a WebSocket route handler. */
|
||||||
|
Loading…
Reference in New Issue
Block a user