2019-02-10 22:06:30 +00:00
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
2021-04-10 21:44:05 +00:00
|
|
|
<title>TemplatedApp | uWebSockets.js v19.0.0 documentation</title>
|
|
|
|
|
<meta name="description" content="Documentation for uWebSockets.js v19.0.0 documentation">
|
2019-02-10 22:06:30 +00:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<header>
|
|
|
|
|
<div class="tsd-page-toolbar">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="table-wrap">
|
2020-06-20 19:55:17 +00:00
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
2019-02-10 22:06:30 +00:00
|
|
|
<div class="field">
|
|
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
|
|
</div>
|
|
|
|
|
<ul class="results">
|
|
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
|
|
</ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<a href="../index.html" class="title">uWebSockets.js v19.0.0 documentation</a>
|
2019-02-10 22:06:30 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="table-cell" id="tsd-widgets">
|
|
|
|
|
<div id="tsd-filter">
|
|
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
|
|
<div class="tsd-filter-group">
|
|
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
|
|
<ul class="tsd-select-list">
|
|
|
|
|
<li data-value="public">Public</li>
|
|
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tsd-page-title">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<ul class="tsd-breadcrumb">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="../index.html">Globals</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="templatedapp.html">TemplatedApp</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Interface TemplatedApp</h1>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</header>
|
|
|
|
|
<div class="container container-main">
|
|
|
|
|
<div class="row">
|
|
|
|
|
<div class="col-8 col-content">
|
|
|
|
|
<section class="tsd-panel tsd-comment">
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
2020-05-20 18:23:46 +00:00
|
|
|
<p>TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual.</p>
|
2019-02-10 22:06:30 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
|
<h3>Hierarchy</h3>
|
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
|
<li>
|
|
|
|
|
<span class="target">TemplatedApp</span>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
|
|
<h2>Index</h2>
|
|
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
|
|
<div class="tsd-index-content">
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-index-section ">
|
2019-02-10 22:06:30 +00:00
|
|
|
<h3>Methods</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#any" class="tsd-kind-icon">any</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#del" class="tsd-kind-icon">del</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#get" class="tsd-kind-icon">get</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#head" class="tsd-kind-icon">head</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a></li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#numsubscribers" class="tsd-kind-icon">num<wbr>Subscribers</a></li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#options" class="tsd-kind-icon">options</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#post" class="tsd-kind-icon">post</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#put" class="tsd-kind-icon">put</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
2019-02-10 22:06:30 +00:00
|
|
|
<h2>Methods</h2>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="any" class="tsd-anchor"></a>
|
|
|
|
|
<h3>any</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">any<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L295">index.d.ts:295</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP handler matching specified URL pattern on any HTTP method.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="connect" class="tsd-anchor"></a>
|
|
|
|
|
<h3>connect</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L291">index.d.ts:291</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP CONNECT handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="del" class="tsd-anchor"></a>
|
|
|
|
|
<h3>del</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L283">index.d.ts:283</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP DELETE handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a name="get" class="tsd-anchor"></a>
|
|
|
|
|
<h3>get</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L277">index.d.ts:277</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP GET handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="head" class="tsd-anchor"></a>
|
|
|
|
|
<h3>head</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L289">index.d.ts:289</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP HEAD handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a name="listen" class="tsd-anchor"></a>
|
|
|
|
|
<h3>listen</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><a href="../enums/listenoptions.html" class="tsd-signature-type">ListenOptions</a>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</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="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L271">index.d.ts:271</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Listens to hostname & port. Callback hands either false or a listen socket.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>host: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>listenSocket: <a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L273">index.d.ts:273</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Listens to port. Callback hands either false or a listen socket.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>listenSocket: <span class="tsd-signature-type">any</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L275">index.d.ts:275</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Listens to port and sets Listen Options. Callback hands either false or a listen socket.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>options: <a href="../enums/listenoptions.html" class="tsd-signature-type">ListenOptions</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>listenSocket<span class="tsd-signature-symbol">: </span><a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>listenSocket: <a href="us_listen_socket.html" class="tsd-signature-type">us_listen_socket</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <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">
|
|
|
|
|
<a name="numsubscribers" class="tsd-anchor"></a>
|
|
|
|
|
<h3>num<wbr>Subscribers</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">num<wbr>Subscribers<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/f246c24/docs/index.d.ts#L301">index.d.ts:301</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Returns number of subscribers for this topic.</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>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="options" class="tsd-anchor"></a>
|
|
|
|
|
<h3>options</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L281">index.d.ts:281</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP OPTIONS handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="patch" class="tsd-anchor"></a>
|
|
|
|
|
<h3>patch</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L285">index.d.ts:285</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP PATCH handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a name="post" class="tsd-anchor"></a>
|
|
|
|
|
<h3>post</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L279">index.d.ts:279</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP POST handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-10 22:06:30 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-10-17 00:29:12 +00:00
|
|
|
<a name="publish" class="tsd-anchor"></a>
|
|
|
|
|
<h3>publish</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2021-04-10 21:44:05 +00:00
|
|
|
<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><span class="tsd-signature-type">boolean</span></li>
|
2019-10-17 00:29:12 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L299">index.d.ts:299</a></li>
|
2019-10-17 00:29:12 +00:00
|
|
|
</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>
|
2021-04-10 21:44:05 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
2019-10-17 00:29:12 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="put" class="tsd-anchor"></a>
|
|
|
|
|
<h3>put</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L287">index.d.ts:287</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP PUT handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="trace" class="tsd-anchor"></a>
|
|
|
|
|
<h3>trace</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">trace<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L293">index.d.ts:293</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers an HTTP TRACE handler matching specified URL pattern.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2020-06-20 19:55:17 +00:00
|
|
|
<h5>handler: <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
<ul class="tsd-parameters">
|
2020-06-20 19:55:17 +00:00
|
|
|
<li class="tsd-parameter-signature">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a>, req<span class="tsd-signature-symbol">: </span><a href="httprequest.html" class="tsd-signature-type">HttpRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>res: <a href="httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>req: <a href="httprequest.html" class="tsd-signature-type">HttpRequest</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-12-21 19:46:31 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a name="ws" class="tsd-anchor"></a>
|
|
|
|
|
<h3>ws</h3>
|
2019-12-21 19:46:31 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
2019-03-03 07:15:48 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a>, behavior<span class="tsd-signature-symbol">: </span><a href="websocketbehavior.html" class="tsd-signature-type">WebSocketBehavior</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/f246c24/docs/index.d.ts#L297">index.d.ts:297</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-03-03 07:15:48 +00:00
|
|
|
<h5>pattern: <a href="../index.html#recognizedstring" class="tsd-signature-type">RecognizedString</a></h5>
|
2019-02-13 03:13:35 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>behavior: <a href="websocketbehavior.html" class="tsd-signature-type">WebSocketBehavior</a></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="templatedapp.html" class="tsd-signature-type">TemplatedApp</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-02-10 22:06:30 +00:00
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
|
|
<nav class="tsd-navigation primary">
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="globals ">
|
|
|
|
|
<a href="../index.html"><em>Globals</em></a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
|
|
<ul class="before-current">
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class=" tsd-kind-enum">
|
|
|
|
|
<a href="../enums/listenoptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
|
|
|
|
</li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
|
|
|
|
<a href="multipartfield.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="current">
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class="current tsd-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
|
|
|
|
<ul>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#any" class="tsd-kind-icon">any</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#del" class="tsd-kind-icon">del</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="templatedapp.html#get" class="tsd-kind-icon">get</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#head" class="tsd-kind-icon">head</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a>
|
|
|
|
|
</li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<a href="templatedapp.html#numsubscribers" class="tsd-kind-icon">num<wbr>Subscribers</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#options" class="tsd-kind-icon">options</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#patch" class="tsd-kind-icon">patch</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="templatedapp.html#post" class="tsd-kind-icon">post</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-10-17 00:29:12 +00:00
|
|
|
<a href="templatedapp.html#publish" class="tsd-kind-icon">publish</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#put" class="tsd-kind-icon">put</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#trace" class="tsd-kind-icon">trace</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="templatedapp.html#ws" class="tsd-kind-icon">ws</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="after-current">
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-13 03:13:35 +00:00
|
|
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
2019-02-10 22:06:30 +00:00
|
|
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
|
|
|
|
</li>
|
2020-06-08 12:29:54 +00:00
|
|
|
<li class=" tsd-kind-interface">
|
|
|
|
|
<a href="us_socket_context_t.html" class="tsd-kind-icon">us_<wbr>socket_<wbr>context_<wbr>t</a>
|
|
|
|
|
</li>
|
2019-11-18 18:37:30 +00:00
|
|
|
<li class=" tsd-kind-type-alias">
|
|
|
|
|
<a href="../index.html#compressoptions" class="tsd-kind-icon">Compress<wbr>Options</a>
|
|
|
|
|
</li>
|
2019-12-21 19:46:31 +00:00
|
|
|
<li class=" tsd-kind-type-alias">
|
2019-03-03 07:15:48 +00:00
|
|
|
<a href="../index.html#recognizedstring" class="tsd-kind-icon">Recognized<wbr>String</a>
|
|
|
|
|
</li>
|
2020-03-01 00:26:30 +00:00
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_128kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>128KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_16kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>16KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_256kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>256KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_32kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>32KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_3kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>3KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_4kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>4KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_64kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>64KB</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#dedicated_compressor_8kb" class="tsd-kind-icon">DEDICATED_<wbr>COMPRESSOR_<wbr>8KB</a>
|
|
|
|
|
</li>
|
2019-11-18 18:37:30 +00:00
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#disabled" class="tsd-kind-icon">DISABLED</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-variable">
|
|
|
|
|
<a href="../index.html#shared_compressor" class="tsd-kind-icon">SHARED_<wbr>COMPRESSOR</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#app" class="tsd-kind-icon">App</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#sslapp" class="tsd-kind-icon">SSLApp</a>
|
|
|
|
|
</li>
|
2021-04-10 21:44:05 +00:00
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#getparts" class="tsd-kind-icon">get<wbr>Parts</a>
|
|
|
|
|
</li>
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class=" tsd-kind-function">
|
|
|
|
|
<a href="../index.html#us_listen_socket_close" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket_<wbr>close</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer class="with-border-bottom">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<h2>Legend</h2>
|
|
|
|
|
<div class="tsd-legend-group">
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
<div class="container tsd-generator">
|
2020-06-20 19:55:17 +00:00
|
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
2019-02-10 22:06:30 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="overlay"></div>
|
|
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
