uwebsockets 2.2.2 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/c-cpp.yml +11 -11
- package/ESM_wrapper.mjs +53 -0
- package/README.md +5 -5
- package/docs/generated/enums/ListenOptions.html +6 -6
- package/docs/generated/functions/App.html +4 -4
- package/docs/generated/functions/SSLApp.html +4 -4
- package/docs/generated/functions/getParts.html +4 -4
- package/docs/generated/functions/us_listen_socket_close.html +4 -4
- package/docs/generated/functions/us_socket_local_port.html +4 -4
- package/docs/generated/index.html +3 -3
- package/docs/generated/interfaces/AppOptions.html +11 -11
- package/docs/generated/interfaces/HttpRequest.html +13 -13
- package/docs/generated/interfaces/HttpResponse.html +22 -22
- package/docs/generated/interfaces/MultipartField.html +8 -8
- package/docs/generated/interfaces/TemplatedApp.html +23 -23
- package/docs/generated/interfaces/WebSocket.html +18 -18
- package/docs/generated/interfaces/WebSocketBehavior.html +19 -19
- package/docs/generated/interfaces/us_listen_socket.html +4 -4
- package/docs/generated/interfaces/us_socket.html +4 -4
- package/docs/generated/interfaces/us_socket_context_t.html +4 -4
- package/docs/generated/types/CompressOptions.html +4 -4
- package/docs/generated/types/RecognizedString.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_128KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_16KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_256KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_32KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_3KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_4KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_64KB.html +4 -4
- package/docs/generated/variables/DEDICATED_COMPRESSOR_8KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_16KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_1KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_2KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_32KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_4KB.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_512B.html +4 -4
- package/docs/generated/variables/DEDICATED_DECOMPRESSOR_8KB.html +4 -4
- package/docs/generated/variables/DISABLED.html +4 -4
- package/docs/generated/variables/SHARED_COMPRESSOR.html +4 -4
- package/docs/generated/variables/SHARED_DECOMPRESSOR.html +4 -4
- package/docs/tsconfig.json +9 -9
- package/examples/SlowReceiver.js +41 -38
- package/index.d.ts +106 -69
- package/logo.svg +1 -0
- package/package.json +1 -1
- package/source_commit +1 -1
- package/tests/Hammer.js +152 -149
- package/tests/fuzzingclient.json +26 -26
- package/uws.js +2 -2
- package/uws_darwin_arm64_108.node +0 -0
- package/uws_darwin_arm64_115.node +0 -0
- package/uws_darwin_arm64_120.node +0 -0
- package/uws_darwin_arm64_93.node +0 -0
- package/uws_darwin_x64_108.node +0 -0
- package/uws_darwin_x64_115.node +0 -0
- package/uws_darwin_x64_120.node +0 -0
- package/uws_darwin_x64_93.node +0 -0
- package/uws_linux_arm64_108.node +0 -0
- package/uws_linux_arm64_115.node +0 -0
- package/uws_linux_arm64_120.node +0 -0
- package/uws_linux_arm64_93.node +0 -0
- package/uws_linux_arm_108.node +0 -0
- package/uws_linux_arm_115.node +0 -0
- package/uws_linux_arm_120.node +0 -0
- package/uws_linux_arm_93.node +0 -0
- package/uws_linux_x64_108.node +0 -0
- package/uws_linux_x64_115.node +0 -0
- package/uws_linux_x64_120.node +0 -0
- package/uws_linux_x64_93.node +0 -0
- package/uws_win32_x64_108.node +0 -0
- package/uws_win32_x64_115.node +0 -0
- package/uws_win32_x64_120.node +0 -0
- package/uws_win32_x64_93.node +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TemplatedApp |
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TemplatedApp | uwebsockets v20.16.0 documentation</title><meta name="description" content="Documentation for uwebsockets v20.16.0 documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
2
|
<div class="tsd-toolbar-contents container">
|
|
3
3
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
4
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
@@ -6,13 +6,13 @@
|
|
|
6
6
|
<div id="tsd-toolbar-links"></div></div>
|
|
7
7
|
<ul class="results">
|
|
8
8
|
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">uwebsockets v20.16.0 documentation</a></div>
|
|
10
10
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
11
|
<div class="container container-main">
|
|
12
12
|
<div class="col-8 col-content">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../index.html">
|
|
15
|
+
<li><a href="../index.html">uwebsockets v20.16.0 documentation</a></li>
|
|
16
16
|
<li><a href="TemplatedApp.html">TemplatedApp</a></li></ul>
|
|
17
17
|
<h1>Interface TemplatedApp</h1></div>
|
|
18
18
|
<section class="tsd-panel tsd-comment">
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
24
|
<li><span class="target">TemplatedApp</span></li></ul></section><aside class="tsd-sources">
|
|
25
25
|
<ul>
|
|
26
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
26
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L281">index.d.ts:281</a></li></ul></aside>
|
|
27
27
|
<section class="tsd-panel-group tsd-index-group">
|
|
28
28
|
<section class="tsd-panel tsd-index-panel">
|
|
29
29
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
<h5>options: <a href="AppOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AppOptions</a></h5></li></ul></div>
|
|
68
68
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
69
69
|
<ul>
|
|
70
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
70
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L315">index.d.ts:315</a></li></ul></aside></li></ul></section>
|
|
71
71
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="any" class="tsd-anchor"></a>
|
|
72
72
|
<h3 class="tsd-anchor-link"><span>any</span><a href="#any" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
73
73
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
98
98
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
99
99
|
<ul>
|
|
100
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
100
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L307">index.d.ts:307</a></li></ul></aside></li></ul></section>
|
|
101
101
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="connect" class="tsd-anchor"></a>
|
|
102
102
|
<h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
103
103
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
128
128
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
129
129
|
<ul>
|
|
130
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
130
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L303">index.d.ts:303</a></li></ul></aside></li></ul></section>
|
|
131
131
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="del" class="tsd-anchor"></a>
|
|
132
132
|
<h3 class="tsd-anchor-link"><span>del</span><a href="#del" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
133
133
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -157,7 +157,7 @@
|
|
|
157
157
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
158
158
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
159
159
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
160
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L295">index.d.ts:295</a></li></ul></aside></li></ul></section>
|
|
161
161
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="get" class="tsd-anchor"></a>
|
|
162
162
|
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
163
163
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -187,7 +187,7 @@
|
|
|
187
187
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
188
188
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
189
189
|
<ul>
|
|
190
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
190
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L289">index.d.ts:289</a></li></ul></aside></li></ul></section>
|
|
191
191
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="head" class="tsd-anchor"></a>
|
|
192
192
|
<h3 class="tsd-anchor-link"><span>head</span><a href="#head" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
193
193
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -217,7 +217,7 @@
|
|
|
217
217
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
218
218
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
219
219
|
<ul>
|
|
220
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
220
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L301">index.d.ts:301</a></li></ul></aside></li></ul></section>
|
|
221
221
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="listen" class="tsd-anchor"></a>
|
|
222
222
|
<h3 class="tsd-anchor-link"><span>listen</span><a href="#listen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
223
223
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -247,7 +247,7 @@
|
|
|
247
247
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
248
248
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
249
249
|
<ul>
|
|
250
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
250
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L283">index.d.ts:283</a></li></ul></aside></li>
|
|
251
251
|
<li class="tsd-signature tsd-anchor-link" id="listen.listen-2">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-symbol">(</span><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a><a href="#listen.listen-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
252
252
|
<li class="tsd-description">
|
|
253
253
|
<div class="tsd-comment tsd-typography"><p>Listens to port. Callback hands either false or a listen socket.</p>
|
|
@@ -272,7 +272,7 @@
|
|
|
272
272
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
273
273
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
274
274
|
<ul>
|
|
275
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
275
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L285">index.d.ts:285</a></li></ul></aside></li>
|
|
276
276
|
<li class="tsd-signature tsd-anchor-link" id="listen.listen-3">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><a href="../enums/ListenOptions.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ListenOptions</a>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><a href="us_listen_socket.html" class="tsd-signature-type" data-tsd-kind="Interface">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a><a href="#listen.listen-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
277
277
|
<li class="tsd-description">
|
|
278
278
|
<div class="tsd-comment tsd-typography"><p>Listens to port and sets Listen Options. Callback hands either false or a listen socket.</p>
|
|
@@ -299,7 +299,7 @@
|
|
|
299
299
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
300
300
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
301
301
|
<ul>
|
|
302
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
302
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L287">index.d.ts:287</a></li></ul></aside></li></ul></section>
|
|
303
303
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="missingServerName" class="tsd-anchor"></a>
|
|
304
304
|
<h3 class="tsd-anchor-link"><span>missing<wbr/>Server<wbr/>Name</span><a href="#missingServerName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
305
305
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -325,7 +325,7 @@
|
|
|
325
325
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
326
326
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
327
327
|
<ul>
|
|
328
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
328
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L319">index.d.ts:319</a></li></ul></aside></li></ul></section>
|
|
329
329
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="numSubscribers" class="tsd-anchor"></a>
|
|
330
330
|
<h3 class="tsd-anchor-link"><span>num<wbr/>Subscribers</span><a href="#numSubscribers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
331
331
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -340,7 +340,7 @@
|
|
|
340
340
|
<h5>topic: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
341
341
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
342
342
|
<ul>
|
|
343
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
343
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L313">index.d.ts:313</a></li></ul></aside></li></ul></section>
|
|
344
344
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="options" class="tsd-anchor"></a>
|
|
345
345
|
<h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
346
346
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -370,7 +370,7 @@
|
|
|
370
370
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
371
371
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
372
372
|
<ul>
|
|
373
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
373
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L293">index.d.ts:293</a></li></ul></aside></li></ul></section>
|
|
374
374
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="patch" class="tsd-anchor"></a>
|
|
375
375
|
<h3 class="tsd-anchor-link"><span>patch</span><a href="#patch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
376
376
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -400,7 +400,7 @@
|
|
|
400
400
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
401
401
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
402
402
|
<ul>
|
|
403
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
403
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L297">index.d.ts:297</a></li></ul></aside></li></ul></section>
|
|
404
404
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="post" class="tsd-anchor"></a>
|
|
405
405
|
<h3 class="tsd-anchor-link"><span>post</span><a href="#post" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
406
406
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -430,7 +430,7 @@
|
|
|
430
430
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
431
431
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
432
432
|
<ul>
|
|
433
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
433
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L291">index.d.ts:291</a></li></ul></aside></li></ul></section>
|
|
434
434
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="publish" class="tsd-anchor"></a>
|
|
435
435
|
<h3 class="tsd-anchor-link"><span>publish</span><a href="#publish" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
436
436
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -451,7 +451,7 @@
|
|
|
451
451
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> compress: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
452
452
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
453
453
|
<ul>
|
|
454
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
454
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L311">index.d.ts:311</a></li></ul></aside></li></ul></section>
|
|
455
455
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="put" class="tsd-anchor"></a>
|
|
456
456
|
<h3 class="tsd-anchor-link"><span>put</span><a href="#put" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
457
457
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -481,7 +481,7 @@
|
|
|
481
481
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
482
482
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
483
483
|
<ul>
|
|
484
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
484
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L299">index.d.ts:299</a></li></ul></aside></li></ul></section>
|
|
485
485
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="removeServerName" class="tsd-anchor"></a>
|
|
486
486
|
<h3 class="tsd-anchor-link"><span>remove<wbr/>Server<wbr/>Name</span><a href="#removeServerName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
487
487
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -496,7 +496,7 @@
|
|
|
496
496
|
<h5>hostname: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
497
497
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
498
498
|
<ul>
|
|
499
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
499
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L317">index.d.ts:317</a></li></ul></aside></li></ul></section>
|
|
500
500
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="trace" class="tsd-anchor"></a>
|
|
501
501
|
<h3 class="tsd-anchor-link"><span>trace</span><a href="#trace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
502
502
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -526,7 +526,7 @@
|
|
|
526
526
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
527
527
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
528
528
|
<ul>
|
|
529
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
529
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L305">index.d.ts:305</a></li></ul></aside></li></ul></section>
|
|
530
530
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="ws" class="tsd-anchor"></a>
|
|
531
531
|
<h3 class="tsd-anchor-link"><span>ws</span><a href="#ws" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
532
532
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -548,7 +548,7 @@
|
|
|
548
548
|
<h5>behavior: <a href="WebSocketBehavior.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocketBehavior</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">UserData</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
549
549
|
<h4 class="tsd-returns-title">Returns <a href="TemplatedApp.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplatedApp</a></h4><aside class="tsd-sources">
|
|
550
550
|
<ul>
|
|
551
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
551
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L309">index.d.ts:309</a></li></ul></aside></li></ul></section></section></div>
|
|
552
552
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
553
553
|
<div class="tsd-navigation settings">
|
|
554
554
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocket |
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocket | uwebsockets v20.16.0 documentation</title><meta name="description" content="Documentation for uwebsockets v20.16.0 documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
2
|
<div class="tsd-toolbar-contents container">
|
|
3
3
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
4
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
@@ -6,13 +6,13 @@
|
|
|
6
6
|
<div id="tsd-toolbar-links"></div></div>
|
|
7
7
|
<ul class="results">
|
|
8
8
|
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">uwebsockets v20.16.0 documentation</a></div>
|
|
10
10
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
11
|
<div class="container container-main">
|
|
12
12
|
<div class="col-8 col-content">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../index.html">
|
|
15
|
+
<li><a href="../index.html">uwebsockets v20.16.0 documentation</a></li>
|
|
16
16
|
<li><a href="WebSocket.html">WebSocket</a></li></ul>
|
|
17
17
|
<h1>Interface WebSocket<UserData></h1></div>
|
|
18
18
|
<section class="tsd-panel tsd-comment">
|
|
@@ -29,7 +29,7 @@ Read more about this in the user manual.</p>
|
|
|
29
29
|
<ul class="tsd-hierarchy">
|
|
30
30
|
<li><span class="target">WebSocket</span></li></ul></section><aside class="tsd-sources">
|
|
31
31
|
<ul>
|
|
32
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
32
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L50">index.d.ts:50</a></li></ul></aside>
|
|
33
33
|
<section class="tsd-panel-group tsd-index-group">
|
|
34
34
|
<section class="tsd-panel tsd-index-panel">
|
|
35
35
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -64,7 +64,7 @@ No WebSocket close message is sent.</p>
|
|
|
64
64
|
</div>
|
|
65
65
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
66
66
|
<ul>
|
|
67
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
67
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L70">index.d.ts:70</a></li></ul></aside></li></ul></section>
|
|
68
68
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="cork" class="tsd-anchor"></a>
|
|
69
69
|
<h3 class="tsd-anchor-link"><span>cork</span><a href="#cork" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
70
70
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -85,7 +85,7 @@ No WebSocket close message is sent.</p>
|
|
|
85
85
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
86
86
|
<h4 class="tsd-returns-title">Returns <a href="WebSocket.html" class="tsd-signature-type" data-tsd-kind="Interface">WebSocket</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">UserData</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
87
87
|
<ul>
|
|
88
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
88
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L93">index.d.ts:93</a></li></ul></aside></li></ul></section>
|
|
89
89
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="end" class="tsd-anchor"></a>
|
|
90
90
|
<h3 class="tsd-anchor-link"><span>end</span><a href="#end" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
91
91
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -103,7 +103,7 @@ A WebSocket close message is sent with code and shortMessage.</p>
|
|
|
103
103
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> shortMessage: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
104
104
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
106
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L65">index.d.ts:65</a></li></ul></aside></li></ul></section>
|
|
107
107
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getBufferedAmount" class="tsd-anchor"></a>
|
|
108
108
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Buffered<wbr/>Amount</span><a href="#getBufferedAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
109
109
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -114,7 +114,7 @@ Check backpressure example.</p>
|
|
|
114
114
|
</div>
|
|
115
115
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
117
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L60">index.d.ts:60</a></li></ul></aside></li></ul></section>
|
|
118
118
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getRemoteAddress" class="tsd-anchor"></a>
|
|
119
119
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Remote<wbr/>Address</span><a href="#getRemoteAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
120
120
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -127,7 +127,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
127
127
|
</div>
|
|
128
128
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4><aside class="tsd-sources">
|
|
129
129
|
<ul>
|
|
130
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
130
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L102">index.d.ts:102</a></li></ul></aside></li></ul></section>
|
|
131
131
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getRemoteAddressAsText" class="tsd-anchor"></a>
|
|
132
132
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Remote<wbr/>Address<wbr/>As<wbr/>Text</span><a href="#getRemoteAddressAsText" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
133
133
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -137,7 +137,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
137
137
|
</div>
|
|
138
138
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4><aside class="tsd-sources">
|
|
139
139
|
<ul>
|
|
140
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
140
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L105">index.d.ts:105</a></li></ul></aside></li></ul></section>
|
|
141
141
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getTopics" class="tsd-anchor"></a>
|
|
142
142
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Topics</span><a href="#getTopics" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
143
143
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -147,7 +147,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
147
147
|
</div>
|
|
148
148
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
149
149
|
<ul>
|
|
150
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
150
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L85">index.d.ts:85</a></li></ul></aside></li></ul></section>
|
|
151
151
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getUserData" class="tsd-anchor"></a>
|
|
152
152
|
<h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Data</span><a href="#getUserData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
153
153
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -157,7 +157,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
157
157
|
</div>
|
|
158
158
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">UserData</span></h4><aside class="tsd-sources">
|
|
159
159
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
160
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L108">index.d.ts:108</a></li></ul></aside></li></ul></section>
|
|
161
161
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="isSubscribed" class="tsd-anchor"></a>
|
|
162
162
|
<h3 class="tsd-anchor-link"><span>is<wbr/>Subscribed</span><a href="#isSubscribed" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
163
163
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -172,7 +172,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
172
172
|
<h5>topic: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
173
173
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
174
174
|
<ul>
|
|
175
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
175
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L82">index.d.ts:82</a></li></ul></aside></li></ul></section>
|
|
176
176
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="ping" class="tsd-anchor"></a>
|
|
177
177
|
<h3 class="tsd-anchor-link"><span>ping</span><a href="#ping" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
178
178
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -187,7 +187,7 @@ IPv6 is 16 byte long and can be converted to text in similar ways, but you typic
|
|
|
187
187
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> message: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
188
188
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
189
189
|
<ul>
|
|
190
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
190
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L73">index.d.ts:73</a></li></ul></aside></li></ul></section>
|
|
191
191
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="publish" class="tsd-anchor"></a>
|
|
192
192
|
<h3 class="tsd-anchor-link"><span>publish</span><a href="#publish" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
193
193
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -209,7 +209,7 @@ Order is guaranteed since v20.</p>
|
|
|
209
209
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> compress: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
210
210
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
211
211
|
<ul>
|
|
212
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
212
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L90">index.d.ts:90</a></li></ul></aside></li></ul></section>
|
|
213
213
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="send" class="tsd-anchor"></a>
|
|
214
214
|
<h3 class="tsd-anchor-link"><span>send</span><a href="#send" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
215
215
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -229,7 +229,7 @@ Order is guaranteed since v20.</p>
|
|
|
229
229
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> compress: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
230
230
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
231
231
|
<ul>
|
|
232
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
232
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L55">index.d.ts:55</a></li></ul></aside></li></ul></section>
|
|
233
233
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="subscribe" class="tsd-anchor"></a>
|
|
234
234
|
<h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
235
235
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -244,7 +244,7 @@ Order is guaranteed since v20.</p>
|
|
|
244
244
|
<h5>topic: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
245
245
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
246
246
|
<ul>
|
|
247
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
247
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L76">index.d.ts:76</a></li></ul></aside></li></ul></section>
|
|
248
248
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="unsubscribe" class="tsd-anchor"></a>
|
|
249
249
|
<h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
250
250
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
@@ -259,7 +259,7 @@ Order is guaranteed since v20.</p>
|
|
|
259
259
|
<h5>topic: <a href="../types/RecognizedString.html" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5></li></ul></div>
|
|
260
260
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
261
261
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/uNetworking/
|
|
262
|
+
<li>Defined in <a href="https://github.com/uNetworking/uwebsockets/blob/master/docs/index.d.ts#L79">index.d.ts:79</a></li></ul></aside></li></ul></section></section></div>
|
|
263
263
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
264
264
|
<div class="tsd-navigation settings">
|
|
265
265
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|