e2m/uWebSockets.js
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document v16.1.0

Browse source
This commit is contained in:
Alex Hultman 2019-10-17 02:29:12 +02:00
parent 97bff11ba0
commit 708afd7d27
13 changed files with 123 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

71
docs/generated/interfaces/templatedapp.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TemplatedApp | uWebSockets.js v16.0.0 documentation</title>
<title>TemplatedApp | uWebSockets.js v16.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 v16.0.0 documentation</a>
<a href="../index.html" class="title">uWebSockets.js v16.1.0 documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -95,6 +95,7 @@
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#post" class="tsd-kind-icon">post</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#put" class="tsd-kind-icon">put</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a></li>
@ -115,7 +116,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L153">index.d.ts:153</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L153">index.d.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -167,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L149">index.d.ts:149</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L149">index.d.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -219,7 +220,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L141">index.d.ts:141</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L141">index.d.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +272,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L135">index.d.ts:135</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L135">index.d.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -323,7 +324,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L147">index.d.ts:147</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L147">index.d.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -376,7 +377,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L131">index.d.ts:131</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L131">index.d.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -419,7 +420,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L133">index.d.ts:133</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L133">index.d.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -468,7 +469,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L139">index.d.ts:139</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L139">index.d.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -520,7 +521,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L143">index.d.ts:143</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L143">index.d.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -572,7 +573,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L137">index.d.ts:137</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L137">index.d.ts:137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -614,6 +615,43 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a name="publish" class="tsd-anchor"></a>
<h3>publish</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, message<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, isBinary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, compress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L157">index.d.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Publishes a message under topic, for all WebSockets under this app. See WebSocket.publish.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topic: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
</li>
<li>
<h5>message: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> isBinary: <span class="tsd-signature-type">boolean</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> compress: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a name="put" class="tsd-anchor"></a>
<h3>put</h3>
@ -624,7 +662,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L145">index.d.ts:145</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L145">index.d.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -676,7 +714,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L151">index.d.ts:151</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L151">index.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -728,7 +766,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/cfbcb55/docs/index.d.ts#L155">index.d.ts:155</a></li>
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/97bff11/docs/index.d.ts#L155">index.d.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -805,6 +843,9 @@
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a href="templatedapp.html#post" class="tsd-kind-icon">post</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
<a href="templatedapp.html#put" class="tsd-kind-icon">put</a>
</li>