Wrap and document unsubscribeAll, ping
This commit is contained in:
Alex Hultman
parent
2db5895dd7
commit
a604881448
12 changed files with 169 additions and 86 deletions
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>WebSocket | uWebSockets.js v17.0.0 documentation</title>
|
||||
<title>WebSocket | uWebSockets.js v17.1.0 documentation</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">uWebSockets.js v17.0.0 documentation</a>
|
||||
<a href="../index.html" class="title">uWebSockets.js v17.1.0 documentation</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -100,10 +100,12 @@
|
|||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#end" class="tsd-kind-icon">end</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#getbufferedamount" class="tsd-kind-icon">get<wbr>Buffered<wbr>Amount</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#ping" class="tsd-kind-icon">ping</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#publish" class="tsd-kind-icon">publish</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#send" class="tsd-kind-icon">send</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="websocket.html#unsubscribeall" class="tsd-kind-icon">unsubscribe<wbr>All</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -121,7 +123,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L23">index.d.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -143,7 +145,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L41">index.d.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -183,7 +185,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L20">index.d.ts:20</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -214,7 +216,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L17">index.d.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -236,7 +238,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L38">index.d.ts:38</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L44">index.d.ts:44</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -248,6 +250,34 @@
|
|||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="ping" class="tsd-anchor"></a>
|
||||
<h3>ping</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Sends a ping control message. Returns true on success, see WebSocket.send. This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...).</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="publish" class="tsd-anchor"></a>
|
||||
<h3>publish</h3>
|
||||
|
|
@ -258,7 +288,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L32">index.d.ts:32</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L38">index.d.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -295,7 +325,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L14">index.d.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -329,7 +359,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L26">index.d.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -357,7 +387,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/6691236/docs/index.d.ts#L29">index.d.ts:29</a></li>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L32">index.d.ts:32</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -375,6 +405,28 @@
|
|||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="unsubscribeall" class="tsd-anchor"></a>
|
||||
<h3>unsubscribe<wbr>All</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">unsubscribe<wbr>All<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/2db5895/docs/index.d.ts#L35">index.d.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Unsubscribe from all topics.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
|
|
@ -419,6 +471,9 @@
|
|||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="websocket.html#getremoteaddress" class="tsd-kind-icon">get<wbr>Remote<wbr>Address</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="websocket.html#ping" class="tsd-kind-icon">ping</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="websocket.html#publish" class="tsd-kind-icon">publish</a>
|
||||
</li>
|
||||
|
|
@ -431,6 +486,9 @@
|
|||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="websocket.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="websocket.html#unsubscribeall" class="tsd-kind-icon">unsubscribe<wbr>All</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue