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">
|
|
|
|
|
<title>TemplatedApp | uWebSockets.js v15.1.0 documentation (WIP & incomplete)</title>
|
|
|
|
|
<meta name="description" content="">
|
|
|
|
|
<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">
|
|
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
|
|
|
<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>
|
|
|
|
|
<a href="../index.html" class="title">uWebSockets.js v15.1.0 documentation (WIP & incomplete)</a>
|
|
|
|
|
</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">
|
|
|
|
|
<p>TemplatedApp is either an SSL or non-SSL app.</p>
|
|
|
|
|
</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">
|
|
|
|
|
<section class="tsd-index-section tsd-is-not-exported">
|
|
|
|
|
<h3>Methods</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#any" class="tsd-kind-icon">any</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#del" class="tsd-kind-icon">del</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#get" class="tsd-kind-icon">get</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#head" class="tsd-kind-icon">head</a></li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported"><a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a></li>
|
2019-02-13 03:13:35 +00:00
|
|
|
<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>
|
2019-02-10 22:06:30 +00:00
|
|
|
<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>
|
2019-02-13 03:13:35 +00:00
|
|
|
<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>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
|
|
|
|
<h2>Methods</h2>
|
2019-02-13 03:13:35 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="any" class="tsd-anchor"></a>
|
|
|
|
|
<h3>any</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">any<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L132">index.d.ts:132</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="connect" class="tsd-anchor"></a>
|
|
|
|
|
<h3>connect</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L128">index.d.ts:128</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="del" class="tsd-anchor"></a>
|
|
|
|
|
<h3>del</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">del<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L120">index.d.ts:120</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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-02-10 22:06:30 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="get" class="tsd-anchor"></a>
|
|
|
|
|
<h3>get</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L114">index.d.ts:114</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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-02-13 03:13:35 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="head" class="tsd-anchor"></a>
|
|
|
|
|
<h3>head</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L126">index.d.ts:126</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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-02-10 22:06:30 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="listen" class="tsd-anchor"></a>
|
|
|
|
|
<h3>listen</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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-type">function</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-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L110">index.d.ts:110</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>
|
|
|
|
|
<h5>host: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>cb: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L112">index.d.ts:112</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>
|
|
|
|
|
<h5>cb: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-02-13 03:13:35 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="options" class="tsd-anchor"></a>
|
|
|
|
|
<h3>options</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L118">index.d.ts:118</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="patch" class="tsd-anchor"></a>
|
|
|
|
|
<h3>patch</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L122">index.d.ts:122</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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-02-10 22:06:30 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="post" class="tsd-anchor"></a>
|
|
|
|
|
<h3>post</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L116">index.d.ts:116</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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-02-13 03:13:35 +00:00
|
|
|
<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>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L124">index.d.ts:124</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="trace" class="tsd-anchor"></a>
|
|
|
|
|
<h3>trace</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">trace<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L130">index.d.ts:130</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li class="tsd-parameter-siganture">
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
|
|
|
|
<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>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a name="ws" class="tsd-anchor"></a>
|
|
|
|
|
<h3>ws</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">ws<span class="tsd-signature-symbol">(</span>pattern<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, 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>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-02-21 19:03:43 +00:00
|
|
|
<li>Defined in <a href="https://github.com/uNetworking/uWebSockets.js/blob/dcfbd23/docs/index.d.ts#L134">index.d.ts:134</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>
|
|
|
|
|
<h5>pattern: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</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">
|
2019-02-21 19:03:43 +00:00
|
|
|
<li class=" tsd-kind-enum">
|
|
|
|
|
<a href="../enums/compressoptions.html" class="tsd-kind-icon">Compress<wbr>Options</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="appoptions.html" class="tsd-kind-icon">App<wbr>Options</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="httprequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="httpresponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="current">
|
|
|
|
|
<li class="current tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html" class="tsd-kind-icon">Templated<wbr>App</a>
|
|
|
|
|
<ul>
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#any" class="tsd-kind-icon">any</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#connect" class="tsd-kind-icon">connect</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#del" class="tsd-kind-icon">del</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#get" class="tsd-kind-icon">get</a>
|
|
|
|
|
</li>
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#head" class="tsd-kind-icon">head</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="templatedapp.html#listen" class="tsd-kind-icon">listen</a>
|
|
|
|
|
</li>
|
2019-02-13 03:13:35 +00:00
|
|
|
<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>
|
2019-02-10 22:06:30 +00:00
|
|
|
<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>
|
2019-02-13 03:13:35 +00:00
|
|
|
<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>
|
2019-02-10 22:06:30 +00:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="after-current">
|
2019-02-13 03:13:35 +00:00
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="websocketbehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
|
|
|
|
|
</li>
|
2019-02-10 22:06:30 +00:00
|
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
|
|
|
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
|
|
|
|
|
</li>
|
|
|
|
|
<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>
|
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-module"><span class="tsd-kind-icon">Module</span></li>
|
|
|
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
|
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
|
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
|
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
|
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
|
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
|
|
<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>
|
|
|
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
|
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
|
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
|
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
|
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
<div class="container tsd-generator">
|
|
|
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
|
|
</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>
|
