robbyson-frontend-library 1.0.75 → 1.0.76
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/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/index.Socket-1.html +61 -40
- package/docs/interfaces/repositories_socket_repository_interface.ISocketRepository.html +2 -2
- package/docs/interfaces/services_chat_service_interface.IChatService.html +2 -7
- package/docs/interfaces/states_chat_container_chat_app_state_interface.IChatApp.html +2 -3
- package/docs/modules/constants.html +1 -2
- package/docs/modules/index.Socket.html +1 -1
- package/docs/modules/index.html +1 -2
- package/docs/modules/repositories.html +1 -2
- package/docs/types/index.Socket.DisconnectReason.html +1 -1
- package/package.json +1 -1
- package/.vscode/launch.json +0 -23
- package/.vscode/tasks.json +0 -21
- package/docs/enums/constants_sounds_constants.SOUNDS_CONSTANTS.html +0 -2
- package/docs/interfaces/repositories_sounds_repository_interface.ISoundsRepository.html +0 -3
- package/docs/modules/constants_sounds_constants.html +0 -2
- package/docs/modules/repositories_sounds_repository_interface.html +0 -2
|
@@ -2,10 +2,11 @@
|
|
|
2
2
|
<p>A Socket belongs to a certain Namespace (by default /) and uses an underlying Manager to communicate.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">();</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"connect"</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">"connected"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">// send an event to the server</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"foo"</span><span class="hl-1">, </span><span class="hl-10">"bar"</span><span class="hl-1">);</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"foobar"</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">// an event was received from the server</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">// upon disconnection</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"disconnect"</span><span class="hl-1">, (</span><span class="hl-0">reason</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`disconnected due to </span><span class="hl-3">${</span><span class="hl-0">reason</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
4
4
|
</code><button>Copy</button></pre>
|
|
5
|
-
</div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="ListenEvents" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ListenEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <span class="tsd-signature-type">DefaultEventsMap</span></h4></li><li><h4><a id="EmitEvents" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">EmitEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a></h4></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Emitter</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">Socket</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:84</li><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
5
|
+
</div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="ListenEvents" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ListenEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <span class="tsd-signature-type">DefaultEventsMap</span></h4></li><li><h4><a id="EmitEvents" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">EmitEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a></h4></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Emitter</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">Socket</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:84</li><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:590</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="index.Socket-1.html#constructor" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
|
|
6
6
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="index.Socket-1.html#_addToQueue" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_add<wbr/>To<wbr/>Queue</span></a>
|
|
7
7
|
<a href="index.Socket-1.html#_anyListeners" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Listeners</span></a>
|
|
8
8
|
<a href="index.Socket-1.html#_anyOutgoingListeners" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Outgoing<wbr/>Listeners</span></a>
|
|
9
|
+
<a href="index.Socket-1.html#_clearAcks" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_clear<wbr/>Acks</span></a>
|
|
9
10
|
<a href="index.Socket-1.html#_drainQueue" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_drain<wbr/>Queue</span></a>
|
|
10
11
|
<a href="index.Socket-1.html#_lastOffset" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_last<wbr/>Offset</span></a>
|
|
11
12
|
<a href="index.Socket-1.html#_opts" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_opts</span></a>
|
|
@@ -70,17 +71,37 @@
|
|
|
70
71
|
<a href="index.Socket-1.html#send" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send</span></a>
|
|
71
72
|
<a href="index.Socket-1.html#timeout" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>timeout</span></a>
|
|
72
73
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Socket" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Socket</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">io</span>, <span class="tsd-kind-parameter">nsp</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.Socket-1.html" class="tsd-signature-type tsd-kind-class">Socket</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_Socket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><code>Socket</code> constructor.</p>
|
|
73
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="constructor.new_Socket.ListenEvents-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ListenEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <span class="tsd-signature-type">DefaultEventsMap</span></h4></li><li><h4><a id="constructor.new_Socket.EmitEvents-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">EmitEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">io</span>: <span class="tsd-signature-type">Manager</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DefaultEventsMap</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventsMap</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-kind-parameter">nsp</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SocketOptions</span><span class="tsd-signature-symbol">></span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.Socket-1.html" class="tsd-signature-type tsd-kind-class">Socket</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Emitter<ListenEvents, EmitEvents, SocketReservedEvents>.constructor</p><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
74
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
74
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="constructor.new_Socket.ListenEvents-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ListenEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <span class="tsd-signature-type">DefaultEventsMap</span></h4></li><li><h4><a id="constructor.new_Socket.EmitEvents-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">EmitEvents</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventsMap</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">io</span>: <span class="tsd-signature-type">Manager</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DefaultEventsMap</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventsMap</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-kind-parameter">nsp</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SocketOptions</span><span class="tsd-signature-symbol">></span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.Socket-1.html" class="tsd-signature-type tsd-kind-class">Socket</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Emitter<ListenEvents, EmitEvents, SocketReservedEvents>.constructor</p><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:205</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_addToQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_add<wbr/>To<wbr/>Queue</span><a href="#_addToQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_add<wbr/>To<wbr/>Queue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Add the packet to the queue.</p>
|
|
75
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:320</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_anyListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_any<wbr/>Listeners</span><a href="#_anyListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_any<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:200</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_anyOutgoingListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_any<wbr/>Outgoing<wbr/>Listeners</span><a href="#_anyOutgoingListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_any<wbr/>Outgoing<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:201</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_clearAcks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_clear<wbr/>Acks</span><a href="#_clearAcks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_clear<wbr/>Acks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Clears the acknowledgement handlers upon disconnection, since the client will never receive an acknowledgement from
|
|
76
|
+
the server.</p>
|
|
77
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:369</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_drainQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_drain<wbr/>Queue</span><a href="#_drainQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_drain<wbr/>Queue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Send the first packet of the queue, and wait for an acknowledgement from the server.</p>
|
|
75
78
|
</div><div class="tsd-comment tsd-typography"><h4>Param: force</h4><p>whether to resend a packet that has not been acknowledged yet</p>
|
|
76
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
79
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:327</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_lastOffset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_last<wbr/>Offset</span><a href="#_lastOffset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_last<wbr/>Offset</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>The offset of the last received packet, which will be sent upon reconnection to allow for the recovery of the connection state.</p>
|
|
77
80
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:110</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_opts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_opts</span><a href="#_opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_opts</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:172</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_pid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_pid</span><a href="#_pid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_pid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>The session ID used for connection state recovery, which must not be shared (unlike <a href="index.Socket-1.html#id" class="tsd-kind-property">id</a>).</p>
|
|
78
81
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:104</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_queue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_queue</span><a href="#_queue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_queue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>The queue of packets to be sent with retry in case of failure.</p>
|
|
79
82
|
<p>Packets are sent one by one, each waiting for the server acknowledgement, in order to guarantee the delivery order.</p>
|
|
80
83
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:165</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_queueSeq" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_queue<wbr/>Seq</span><a href="#_queueSeq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_queue<wbr/>Seq</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>A sequence to generate the ID of the QueuedPacket.</p>
|
|
81
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:170</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_registerAckCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_register<wbr/>Ack<wbr/>Callback</span><a href="#_registerAckCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_register<wbr/>Ack<wbr/>Callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
82
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: data</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
83
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
84
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:170</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_registerAckCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_register<wbr/>Ack<wbr/>Callback</span><a href="#_registerAckCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_register<wbr/>Ack<wbr/>Callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:297</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="_sendConnectPacket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_send<wbr/>Connect<wbr/>Packet</span><a href="#_sendConnectPacket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_send<wbr/>Connect<wbr/>Packet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Sends a CONNECT packet to initiate the Socket.IO session.</p>
|
|
85
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: data</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:347</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="ack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ack</span><a href="#ack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Produces an ack callback to emit with an event.</p>
|
|
86
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:390</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="acks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>acks</span><a href="#acks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">acks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>A map containing acknowledgement handlers.</p>
|
|
87
|
+
<p>The <code>withError</code> attribute is used to differentiate handlers that accept an error as first argument:</p>
|
|
88
|
+
<ul>
|
|
89
|
+
<li><code>socket.emit("test", (err, value) => { ... })</code> with <code>ackTimeout</code> option</li>
|
|
90
|
+
<li><code>socket.timeout(5000).emit("test", (err, value) => { ... })</code></li>
|
|
91
|
+
<li><code>const value = await socket.emitWithAck("test")</code></li>
|
|
92
|
+
</ul>
|
|
93
|
+
<p>From those that don't:</p>
|
|
94
|
+
<ul>
|
|
95
|
+
<li><code>socket.emit("test", (value) => { ... });</code></li>
|
|
96
|
+
</ul>
|
|
97
|
+
<p>In the first case, the handlers will be called with an error when:</p>
|
|
98
|
+
<ul>
|
|
99
|
+
<li>the timeout is reached</li>
|
|
100
|
+
<li>the socket gets disconnected</li>
|
|
101
|
+
</ul>
|
|
102
|
+
<p>In the second case, the handlers will be simply discarded upon disconnection, since the client will never receive
|
|
103
|
+
an acknowledgement from the server.</p>
|
|
104
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:197</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="auth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>auth</span><a href="#auth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</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></div><div class="tsd-comment tsd-typography"><p>Credentials that are sent when accessing a namespace.</p>
|
|
84
105
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">object</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">auth:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">token:</span><span class="hl-1"> </span><span class="hl-10">"abcd"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">// or with a function</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-7">auth</span><span class="hl-0">:</span><span class="hl-1"> (</span><span class="hl-0">cb</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">cb</span><span class="hl-1">({ </span><span class="hl-0">token:</span><span class="hl-1"> </span><span class="hl-0">localStorage</span><span class="hl-1">.</span><span class="hl-0">token</span><span class="hl-1"> })</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
85
106
|
</code><button>Copy</button></pre>
|
|
86
107
|
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="connected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connected</span><a href="#connected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the socket is currently connected to the server.</p>
|
|
@@ -89,57 +110,57 @@
|
|
|
89
110
|
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:125</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">destroy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon forced client/server side disconnections,
|
|
90
111
|
this method ensures the manager stops tracking us and
|
|
91
112
|
that reconnections don't get triggered for this.</p>
|
|
92
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
93
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
113
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:423</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="emitBuffered" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>emit<wbr/>Buffered</span><a href="#emitBuffered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit<wbr/>Buffered</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Emit buffered events (received and emitted).</p>
|
|
114
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:409</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="emitEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>emit<wbr/>Event</span><a href="#emitEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emit<wbr/>Event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:384</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>flags</span><a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A unique identifier for the session. <code>undefined</code> when the socket is not connected.</p>
|
|
94
115
|
</div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">();</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">id</span><span class="hl-1">); </span><span class="hl-2">// undefined</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"connect"</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">id</span><span class="hl-1">); </span><span class="hl-2">// "G5p5..."</span><br/><span class="hl-1">});</span>
|
|
95
116
|
</code><button>Copy</button></pre>
|
|
96
117
|
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:98</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="ids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ids</span><a href="#ids" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:173</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="io" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>io</span><a href="#io" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">io</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Manager</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:85</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="notifyOutgoingListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>notify<wbr/>Outgoing<wbr/>Listeners</span><a href="#notifyOutgoingListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notify<wbr/>Outgoing<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Notify the listeners for each packet sent</p>
|
|
97
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
98
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
99
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: reason</h4><h4>Param: description</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
100
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
101
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
102
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: err</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
103
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
104
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
105
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
106
|
-
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
118
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:588</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="nsp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>nsp</span><a href="#nsp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">nsp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:171</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onack</span><a href="#onack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon a server acknowledgement.</p>
|
|
119
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:397</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onclose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onclose</span><a href="#onclose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onclose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon engine <code>close</code>.</p>
|
|
120
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: reason</h4><h4>Param: description</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:362</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onconnect</span><a href="#onconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onconnect</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon server connect.</p>
|
|
121
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:403</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="ondisconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ondisconnect</span><a href="#ondisconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ondisconnect</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon server disconnect.</p>
|
|
122
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:415</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onerror" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onerror</span><a href="#onerror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onerror</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon engine or manager <code>error</code>.</p>
|
|
123
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: err</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:354</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onevent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onevent</span><a href="#onevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onevent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon a server event.</p>
|
|
124
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:383</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onopen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onopen</span><a href="#onopen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onopen</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called upon engine <code>open</code>.</p>
|
|
125
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:340</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="onpacket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>onpacket</span><a href="#onpacket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onpacket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Called with socket packet.</p>
|
|
126
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:376</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="packet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>packet</span><a href="#packet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">packet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Sends a packet.</p>
|
|
127
|
+
</div><div class="tsd-comment tsd-typography"><h4>Param: packet</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:334</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="receiveBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>receive<wbr/>Buffer</span><a href="#receiveBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">receive<wbr/>Buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Buffer for packets received before the CONNECT packet</p>
|
|
107
128
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:154</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="recovered" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>recovered</span><a href="#recovered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">recovered</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the connection state was recovered after a temporary disconnection. In that case, any missed packets will
|
|
108
129
|
be transmitted by the server.</p>
|
|
109
130
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:130</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="sendBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Buffer</span><a href="#sendBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">send<wbr/>Buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Packet</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Buffer for packets that will be sent once the socket is connected</p>
|
|
110
131
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:158</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="subEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>sub<wbr/>Events</span><a href="#subEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sub<wbr/>Events</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Subscribe to open, close and packet events</p>
|
|
111
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
132
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:226</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="subs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>subs</span><a href="#subs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:199</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="active" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>active</span><a href="#active" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="active.active-1"><span class="tsd-signature-keyword">get</span> active<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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether the Socket will try to reconnect when its Manager connects or reconnects.</p>
|
|
112
133
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">();</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">active</span><span class="hl-1">); </span><span class="hl-2">// true</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"disconnect"</span><span class="hl-1">, (</span><span class="hl-0">reason</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">if</span><span class="hl-1"> (</span><span class="hl-0">reason</span><span class="hl-1"> === </span><span class="hl-10">"io server disconnect"</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">// the disconnection was initiated by the server, you need to manually reconnect</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">active</span><span class="hl-1">); </span><span class="hl-2">// false</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-2">// else the socket will automatically try to reconnect</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">active</span><span class="hl-1">); </span><span class="hl-2">// true</span><br/><span class="hl-1">});</span>
|
|
113
134
|
</code><button>Copy</button></pre>
|
|
114
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
135
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:244</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="disconnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disconnected</span><a href="#disconnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="disconnected.disconnected-1"><span class="tsd-signature-keyword">get</span> disconnected<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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether the socket is currently disconnected</p>
|
|
115
136
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">();</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"connect"</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">disconnected</span><span class="hl-1">); </span><span class="hl-2">// false</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"disconnect"</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">disconnected</span><span class="hl-1">); </span><span class="hl-2">// true</span><br/><span class="hl-1">});</span>
|
|
116
137
|
</code><button>Copy</button></pre>
|
|
117
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
138
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:220</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="volatile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>volatile</span><a href="#volatile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="volatile.volatile-1"><span class="tsd-signature-keyword">get</span> volatile<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets a modifier for a subsequent event emission that the event message will be dropped when this socket is not
|
|
118
139
|
ready to send messages.</p>
|
|
119
140
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>self</p>
|
|
120
141
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-0">volatile</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">); </span><span class="hl-2">// the server may or may not receive it</span>
|
|
121
142
|
</code><button>Copy</button></pre>
|
|
122
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
143
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:466</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="close.close-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Alias for <a href="index.Socket-1.html#disconnect" class="tsd-kind-method">()</a>.</p>
|
|
123
144
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>self</p>
|
|
124
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
145
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:446</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="compress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>compress</span><a href="#compress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="compress.compress-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">compress</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">compress</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#compress.compress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the compress flag.</p>
|
|
125
146
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">compress</span>: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if <code>true</code>, compresses the sending data</p>
|
|
126
147
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>self</p>
|
|
127
148
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">compress</span><span class="hl-1">(</span><span class="hl-3">false</span><span class="hl-1">).</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">);</span>
|
|
128
149
|
</code><button>Copy</button></pre>
|
|
129
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
150
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:456</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="connect.connect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>"Opens" the socket.</p>
|
|
130
151
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">autoConnect:</span><span class="hl-1"> </span><span class="hl-3">false</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">connect</span><span class="hl-1">();</span>
|
|
131
152
|
</code><button>Copy</button></pre>
|
|
132
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
153
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:255</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="disconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="disconnect.disconnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disconnect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#disconnect.disconnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disconnects the socket manually. In that case, the socket will not try to reconnect.</p>
|
|
133
154
|
<p>If this is the last active Socket instance of the Manager, the low-level connection will be closed.</p>
|
|
134
155
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>self</p>
|
|
135
156
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">socket</span><span class="hl-1"> = </span><span class="hl-7">io</span><span class="hl-1">();</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-10">"disconnect"</span><span class="hl-1">, (</span><span class="hl-0">reason</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">// console.log(reason); prints "io client disconnect"</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">disconnect</span><span class="hl-1">();</span>
|
|
136
157
|
</code><button>Copy</button></pre>
|
|
137
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
158
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:440</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="emit.emit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emit.emit-1.Ev">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Override <code>emit</code>.
|
|
138
159
|
If the event is in <code>events</code>, it's emitted normally.</p>
|
|
139
160
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="emit.emit-1.Ev" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emit.emit-1.Ev">Ev</a></h5></li><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emit.emit-1.Ev">Ev</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>self</p>
|
|
140
161
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">, </span><span class="hl-10">"world"</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// all serializable datastructures are supported (no need to call JSON.stringify)</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">, </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-10">"2"</span><span class="hl-1">, { </span><span class="hl-8">3</span><span class="hl-0">:</span><span class="hl-1"> [</span><span class="hl-10">"4"</span><span class="hl-1">], </span><span class="hl-8">5</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">Uint8Array</span><span class="hl-1">.</span><span class="hl-7">from</span><span class="hl-1">([</span><span class="hl-8">6</span><span class="hl-1">]) });</span><br/><br/><span class="hl-2">// with an acknowledgement from the server</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">, </span><span class="hl-10">"world"</span><span class="hl-1">, (</span><span class="hl-0">val</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">// ...</span><br/><span class="hl-1">});</span>
|
|
141
162
|
</code><button>Copy</button></pre>
|
|
142
|
-
</div><aside class="tsd-sources"><p>Overrides Emitter.emit</p><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
163
|
+
</div><aside class="tsd-sources"><p>Overrides Emitter.emit</p><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:293</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="emitReserved" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>emit<wbr/>Reserved</span><a href="#emitReserved" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="emitReserved.emitReserved-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">emit<wbr/>Reserved</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emitReserved.emitReserved-1.Ev-1">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#emitReserved.emitReserved-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Emits a reserved event.</p>
|
|
143
164
|
<p>This method is <code>protected</code>, so that only a class extending
|
|
144
165
|
<code>StrictEventEmitter</code> can emit its own reserved events.</p>
|
|
145
166
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="emitReserved.emitReserved-1.Ev-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emitReserved.emitReserved-1.Ev-1">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Reserved event name</p>
|
|
@@ -148,7 +169,7 @@ If the event is in <code>events</code>, it's emitted normally.</p>
|
|
|
148
169
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="emitWithAck.emitWithAck-1.Ev-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emitWithAck.emitWithAck-1.Ev-2">Ev</a></h5></li><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">AllButLast</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emitWithAck.emitWithAck-1.Ev-2">Ev</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FirstArg</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Last</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#emitWithAck.emitWithAck-1.Ev-2">Ev</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>a Promise that will be fulfilled when the server acknowledges the event</p>
|
|
149
170
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-2">// without timeout</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">response</span><span class="hl-1"> = </span><span class="hl-9">await</span><span class="hl-1"> </span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emitWithAck</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">, </span><span class="hl-10">"world"</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// with a specific timeout</span><br/><span class="hl-9">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">response</span><span class="hl-1"> = </span><span class="hl-9">await</span><span class="hl-1"> </span><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">timeout</span><span class="hl-1">(</span><span class="hl-8">1000</span><span class="hl-1">).</span><span class="hl-7">emitWithAck</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">, </span><span class="hl-10">"world"</span><span class="hl-1">);</span><br/><span class="hl-1">} </span><span class="hl-9">catch</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">// the server did not acknowledge the event in the given delay</span><br/><span class="hl-1">}</span>
|
|
150
171
|
</code><button>Copy</button></pre>
|
|
151
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
172
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:314</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="hasListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Listeners</span><a href="#hasListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="hasListeners.hasListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">has<wbr/>Listeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#hasListeners.hasListeners-1.Ev-3">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasListeners.hasListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if there is a listener for this event.</p>
|
|
152
173
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="hasListeners.hasListeners-1.Ev-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#hasListeners.hasListeners-1.Ev-3">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Event name</p>
|
|
153
174
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>boolean</p>
|
|
154
175
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.hasListeners</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:154</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="listeners.listeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#listeners.listeners-1.Ev-4">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FallbackToUntypedListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#listeners.listeners-1.Ev-4">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><br/><span> </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#listeners.listeners-1.Ev-4">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the listeners listening to an event.</p>
|
|
@@ -156,44 +177,44 @@ If the event is in <code>events</code>, it's emitted normally.</p>
|
|
|
156
177
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FallbackToUntypedListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#listeners.listeners-1.Ev-4">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><br/><span> </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#listeners.listeners-1.Ev-4">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><p>Array of listeners subscribed to <code>event</code></p>
|
|
157
178
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.listeners</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:144</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="listenersAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listeners<wbr/>Any</span><a href="#listenersAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="listenersAny.listenersAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listeners<wbr/>Any</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><a href="#listenersAny.listenersAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of listeners that are listening for any event that is specified. This array can be manipulated,
|
|
158
179
|
e.g. to remove listeners.</p>
|
|
159
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
180
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:528</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="listenersAnyOutgoing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listeners<wbr/>Any<wbr/>Outgoing</span><a href="#listenersAnyOutgoing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="listenersAnyOutgoing.listenersAnyOutgoing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listeners<wbr/>Any<wbr/>Outgoing</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><a href="#listenersAnyOutgoing.listenersAnyOutgoing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of listeners that are listening for any event that is specified. This array can be manipulated,
|
|
160
181
|
e.g. to remove listeners.</p>
|
|
161
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
182
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:580</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="off.off-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#off.off-1.Ev-5">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the <code>listener</code> function as an event listener for <code>ev</code>.</p>
|
|
162
183
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="off.off-1.Ev-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#off.off-1.Ev-5">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Name of the event</p>
|
|
163
184
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">FallbackToUntypedListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#off.off-1.Ev-5">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><br/><span> </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#off.off-1.Ev-5">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>Callback function</p>
|
|
164
185
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.off</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:108</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="offAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off<wbr/>Any</span><a href="#offAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="offAny.offAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off<wbr/>Any</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#offAny.offAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the listener that will be fired when any event is emitted.</p>
|
|
165
186
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-7">catchAllListener</span><span class="hl-1"> = (</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`got event </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">onAny</span><span class="hl-1">(</span><span class="hl-0">catchAllListener</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// remove a specific listener</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">offAny</span><span class="hl-1">(</span><span class="hl-0">catchAllListener</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// or remove all listeners</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">offAny</span><span class="hl-1">();</span>
|
|
166
187
|
</code><button>Copy</button></pre>
|
|
167
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
188
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:523</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="offAnyOutgoing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off<wbr/>Any<wbr/>Outgoing</span><a href="#offAnyOutgoing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="offAnyOutgoing.offAnyOutgoing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off<wbr/>Any<wbr/>Outgoing</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#offAnyOutgoing.offAnyOutgoing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the listener that will be fired when any event is emitted.</p>
|
|
168
189
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"><p>the catch-all listener (optional)</p>
|
|
169
190
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-7">catchAllListener</span><span class="hl-1"> = (</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`sent event </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">onAnyOutgoing</span><span class="hl-1">(</span><span class="hl-0">catchAllListener</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// remove a specific listener</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">offAnyOutgoing</span><span class="hl-1">(</span><span class="hl-0">catchAllListener</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// or remove all listeners</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">offAnyOutgoing</span><span class="hl-1">();</span>
|
|
170
191
|
</code><button>Copy</button></pre>
|
|
171
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
192
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:575</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="on.on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#on.on-1.Ev-6">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function as an event listener for <code>ev</code>.</p>
|
|
172
193
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="on.on-1.Ev-6" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#on.on-1.Ev-6">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Name of the event</p>
|
|
173
194
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">FallbackToUntypedListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#on.on-1.Ev-6">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><br/><span> </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#on.on-1.Ev-6">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>Callback function</p>
|
|
174
195
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.on</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:86</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="onAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Any</span><a href="#onAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="onAny.onAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Any</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#onAny.onAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the
|
|
175
196
|
callback.</p>
|
|
176
197
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">onAny</span><span class="hl-1">((</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`got </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
177
198
|
</code><button>Copy</button></pre>
|
|
178
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
199
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:492</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="onAnyOutgoing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Any<wbr/>Outgoing</span><a href="#onAnyOutgoing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="onAnyOutgoing.onAnyOutgoing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Any<wbr/>Outgoing</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#onAnyOutgoing.onAnyOutgoing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the
|
|
179
200
|
callback.</p>
|
|
180
201
|
<p>Note: acknowledgements sent to the server are not included.</p>
|
|
181
202
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">onAnyOutgoing</span><span class="hl-1">((</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`sent event </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
182
203
|
</code><button>Copy</button></pre>
|
|
183
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
204
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:542</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="once.once-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#once.once-1.Ev-7">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a one-time <code>listener</code> function as an event listener for <code>ev</code>.</p>
|
|
184
205
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="once.once-1.Ev-7" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#once.once-1.Ev-7">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Name of the event</p>
|
|
185
206
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type">FallbackToUntypedListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#once.once-1.Ev-7">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connect_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disconnect"</span><br/><span> </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SocketReservedEvents</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#once.once-1.Ev-7">Ev</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EventNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">Ev</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>Callback function</p>
|
|
186
207
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.once</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:97</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="open" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>open</span><a href="#open" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="open.open-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">open</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#open.open-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Alias for <a href="index.Socket-1.html#connect" class="tsd-kind-method">()</a>.</p>
|
|
187
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
208
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:259</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="prependAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>prepend<wbr/>Any</span><a href="#prependAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="prependAny.prependAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">prepend<wbr/>Any</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#prependAny.prependAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the
|
|
188
209
|
callback. The listener is added to the beginning of the listeners array.</p>
|
|
189
210
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">prependAny</span><span class="hl-1">((</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`got event </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
190
211
|
</code><button>Copy</button></pre>
|
|
191
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
212
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:504</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="prependAnyOutgoing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>prepend<wbr/>Any<wbr/>Outgoing</span><a href="#prependAnyOutgoing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="prependAnyOutgoing.prependAnyOutgoing-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">prepend<wbr/>Any<wbr/>Outgoing</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#prependAnyOutgoing.prependAnyOutgoing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a listener that will be fired when any event is emitted. The event name is passed as the first argument to the
|
|
192
213
|
callback. The listener is added to the beginning of the listeners array.</p>
|
|
193
214
|
<p>Note: acknowledgements sent to the server are not included.</p>
|
|
194
215
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">prependAnyOutgoing</span><span class="hl-1">((</span><span class="hl-0">event</span><span class="hl-1">, ...</span><span class="hl-0">args</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-10">`sent event </span><span class="hl-3">${</span><span class="hl-0">event</span><span class="hl-3">}</span><span class="hl-10">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
195
216
|
</code><button>Copy</button></pre>
|
|
196
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
217
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:556</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removeAllListeners.removeAllListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#removeAllListeners.removeAllListeners-1.Ev-8">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all <code>listener</code> function as an event listener for <code>ev</code>.</p>
|
|
197
218
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="removeAllListeners.removeAllListeners-1.Ev-8" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#removeAllListeners.removeAllListeners-1.Ev-8">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Name of the event</p>
|
|
198
219
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Emitter.removeAllListeners</p><ul><li>Defined in node_modules/@socket.io/component-emitter/index.d.ts:176</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removeListener.removeListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#removeListener.removeListener-1.Ev-9">Ev</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ev</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the <code>listener</code> function as an event listener for <code>ev</code>.</p>
|
|
199
220
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="removeListener.removeListener-1.Ev-9" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Ev</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">ev</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#removeListener.removeListener-1.Ev-9">Ev</a></h5><div class="tsd-comment tsd-typography"><p>Name of the event</p>
|
|
@@ -204,9 +225,9 @@ callback. The listener is added to the beginning of the listeners array.</p>
|
|
|
204
225
|
<div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send">https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send</a></p>
|
|
205
226
|
<h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">send</span><span class="hl-1">(</span><span class="hl-10">"hello"</span><span class="hl-1">);</span><br/><br/><span class="hl-2">// this is equivalent to</span><br/><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"message"</span><span class="hl-1">, </span><span class="hl-10">"hello"</span><span class="hl-1">);</span>
|
|
206
227
|
</code><button>Copy</button></pre>
|
|
207
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:
|
|
228
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:275</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="timeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="timeout.timeout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">timeout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.Socket-1.html" class="tsd-signature-type tsd-kind-class">Socket</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DecorateAcknowledgements</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#timeout.timeout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets a modifier for a subsequent event emission that the callback will be called with an error when the
|
|
208
229
|
given number of milliseconds have elapsed without an acknowledgement from the server:</p>
|
|
209
230
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.Socket-1.html" class="tsd-signature-type tsd-kind-class">Socket</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.ListenEvents-1">ListenEvents</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DecorateAcknowledgements</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Socket-1.html#constructor.new_Socket.EmitEvents-1">EmitEvents</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>self</p>
|
|
210
231
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">socket</span><span class="hl-1">.</span><span class="hl-7">timeout</span><span class="hl-1">(</span><span class="hl-8">5000</span><span class="hl-1">).</span><span class="hl-7">emit</span><span class="hl-1">(</span><span class="hl-10">"my-event"</span><span class="hl-1">, (</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">if</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">// the server did not acknowledge the event in the given delay</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
211
232
|
</code><button>Copy</button></pre>
|
|
212
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:450</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#_addToQueue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_add<wbr/>To<wbr/>Queue</span></a></li><li><a href="#_anyListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Listeners</span></a></li><li><a href="#_anyOutgoingListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Outgoing<wbr/>Listeners</span></a></li><li><a href="#_drainQueue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_drain<wbr/>Queue</span></a></li><li><a href="#_lastOffset" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_last<wbr/>Offset</span></a></li><li><a href="#_opts" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_opts</span></a></li><li><a href="#_pid" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_pid</span></a></li><li><a href="#_queue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_queue</span></a></li><li><a href="#_queueSeq" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_queue<wbr/>Seq</span></a></li><li><a href="#_registerAckCallback" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_register<wbr/>Ack<wbr/>Callback</span></a></li><li><a href="#_sendConnectPacket" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_send<wbr/>Connect<wbr/>Packet</span></a></li><li><a href="#ack" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ack</span></a></li><li><a href="#acks" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>acks</span></a></li><li><a href="#auth" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth</span></a></li><li><a href="#connected" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>connected</span></a></li><li><a href="#destroy" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroy</span></a></li><li><a href="#emitBuffered" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emit<wbr/>Buffered</span></a></li><li><a href="#emitEvent" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emit<wbr/>Event</span></a></li><li><a href="#flags" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>flags</span></a></li><li><a href="#id" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id</span></a></li><li><a href="#ids" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ids</span></a></li><li><a href="#io" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>io</span></a></li><li><a href="#notifyOutgoingListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>notify<wbr/>Outgoing<wbr/>Listeners</span></a></li><li><a href="#nsp" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>nsp</span></a></li><li><a href="#onack" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onack</span></a></li><li><a href="#onclose" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onclose</span></a></li><li><a href="#onconnect" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onconnect</span></a></li><li><a href="#ondisconnect" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ondisconnect</span></a></li><li><a href="#onerror" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onerror</span></a></li><li><a href="#onevent" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onevent</span></a></li><li><a href="#onopen" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onopen</span></a></li><li><a href="#onpacket" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onpacket</span></a></li><li><a href="#packet" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>packet</span></a></li><li><a href="#receiveBuffer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>receive<wbr/>Buffer</span></a></li><li><a href="#recovered" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>recovered</span></a></li><li><a href="#sendBuffer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>send<wbr/>Buffer</span></a></li><li><a href="#subEvents" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>sub<wbr/>Events</span></a></li><li><a href="#subs" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>subs</span></a></li><li><a href="#active" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>active</span></a></li><li><a href="#disconnected" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>disconnected</span></a></li><li><a href="#volatile" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>volatile</span></a></li><li><a href="#close" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close</span></a></li><li><a href="#compress" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compress</span></a></li><li><a href="#connect" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>connect</span></a></li><li><a href="#disconnect" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disconnect</span></a></li><li><a href="#emit" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a></li><li><a href="#emitReserved" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Reserved</span></a></li><li><a href="#emitWithAck" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>With<wbr/>Ack</span></a></li><li><a href="#hasListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Listeners</span></a></li><li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a></li><li><a href="#listenersAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners<wbr/>Any</span></a></li><li><a href="#listenersAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li><li><a href="#offAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off<wbr/>Any</span></a></li><li><a href="#offAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li><li><a href="#onAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Any</span></a></li><li><a href="#onAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li><li><a href="#open" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>open</span></a></li><li><a href="#prependAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Any</span></a></li><li><a href="#prependAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a></li><li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a></li><li><a href="#send" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send</span></a></li><li><a href="#timeout" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>timeout</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Robbyson Frontend Library</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../modules/components.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>components</a></li><li><a href="../modules/constants.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>constants</a></li><li><a href="../modules/factories.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>factories</a></li><li><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>index</a></li><li><a href="../modules/ioc.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>ioc</a></li><li><a href="../modules/models.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>models</a></li><li><a href="../modules/repositories.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>repositories</a></li><li><a href="../modules/services.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>services</a></li><li><a href="../modules/states.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>states</a></li><li><a href="../modules/types.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>types</a></li><li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>utils</a></li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><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></g><g id="icon-search"><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></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>
|
|
233
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/socket.io-client/build/esm/socket.d.ts:480</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#_addToQueue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_add<wbr/>To<wbr/>Queue</span></a></li><li><a href="#_anyListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Listeners</span></a></li><li><a href="#_anyOutgoingListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_any<wbr/>Outgoing<wbr/>Listeners</span></a></li><li><a href="#_clearAcks" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_clear<wbr/>Acks</span></a></li><li><a href="#_drainQueue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_drain<wbr/>Queue</span></a></li><li><a href="#_lastOffset" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_last<wbr/>Offset</span></a></li><li><a href="#_opts" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_opts</span></a></li><li><a href="#_pid" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_pid</span></a></li><li><a href="#_queue" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_queue</span></a></li><li><a href="#_queueSeq" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_queue<wbr/>Seq</span></a></li><li><a href="#_registerAckCallback" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_register<wbr/>Ack<wbr/>Callback</span></a></li><li><a href="#_sendConnectPacket" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_send<wbr/>Connect<wbr/>Packet</span></a></li><li><a href="#ack" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ack</span></a></li><li><a href="#acks" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>acks</span></a></li><li><a href="#auth" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth</span></a></li><li><a href="#connected" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>connected</span></a></li><li><a href="#destroy" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroy</span></a></li><li><a href="#emitBuffered" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emit<wbr/>Buffered</span></a></li><li><a href="#emitEvent" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emit<wbr/>Event</span></a></li><li><a href="#flags" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>flags</span></a></li><li><a href="#id" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id</span></a></li><li><a href="#ids" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ids</span></a></li><li><a href="#io" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>io</span></a></li><li><a href="#notifyOutgoingListeners" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>notify<wbr/>Outgoing<wbr/>Listeners</span></a></li><li><a href="#nsp" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>nsp</span></a></li><li><a href="#onack" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onack</span></a></li><li><a href="#onclose" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onclose</span></a></li><li><a href="#onconnect" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onconnect</span></a></li><li><a href="#ondisconnect" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ondisconnect</span></a></li><li><a href="#onerror" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onerror</span></a></li><li><a href="#onevent" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onevent</span></a></li><li><a href="#onopen" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onopen</span></a></li><li><a href="#onpacket" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>onpacket</span></a></li><li><a href="#packet" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>packet</span></a></li><li><a href="#receiveBuffer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>receive<wbr/>Buffer</span></a></li><li><a href="#recovered" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>recovered</span></a></li><li><a href="#sendBuffer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>send<wbr/>Buffer</span></a></li><li><a href="#subEvents" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>sub<wbr/>Events</span></a></li><li><a href="#subs" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>subs</span></a></li><li><a href="#active" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>active</span></a></li><li><a href="#disconnected" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>disconnected</span></a></li><li><a href="#volatile" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>volatile</span></a></li><li><a href="#close" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close</span></a></li><li><a href="#compress" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compress</span></a></li><li><a href="#connect" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>connect</span></a></li><li><a href="#disconnect" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disconnect</span></a></li><li><a href="#emit" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a></li><li><a href="#emitReserved" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Reserved</span></a></li><li><a href="#emitWithAck" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>With<wbr/>Ack</span></a></li><li><a href="#hasListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Listeners</span></a></li><li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a></li><li><a href="#listenersAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners<wbr/>Any</span></a></li><li><a href="#listenersAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li><li><a href="#offAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off<wbr/>Any</span></a></li><li><a href="#offAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li><li><a href="#onAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Any</span></a></li><li><a href="#onAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li><li><a href="#open" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>open</span></a></li><li><a href="#prependAny" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Any</span></a></li><li><a href="#prependAnyOutgoing" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Any<wbr/>Outgoing</span></a></li><li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a></li><li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a></li><li><a href="#send" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send</span></a></li><li><a href="#timeout" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>timeout</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Robbyson Frontend Library</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../modules/components.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>components</a></li><li><a href="../modules/constants.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>constants</a></li><li><a href="../modules/factories.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>factories</a></li><li><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>index</a></li><li><a href="../modules/ioc.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>ioc</a></li><li><a href="../modules/models.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>models</a></li><li><a href="../modules/repositories.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>repositories</a></li><li><a href="../modules/services.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>services</a></li><li><a href="../modules/states.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>states</a></li><li><a href="../modules/types.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>types</a></li><li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>utils</a></li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><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></g><g id="icon-search"><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></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>
|