uWebSockets.js/docs/generated/interfaces/HttpRequest.html
e3dio 81ab2a13fd
fix typedoc gen (#601)
Co-authored-by: e3dio <>
2021-08-16 03:09:11 +02:00

466 lines
22 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HttpRequest | uWebSockets.js v19.3.0 documentation</title>
<meta name="description" content="Documentation for uWebSockets.js v19.3.0 documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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 v19.3.0 documentation</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>
</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">uWebSockets.js v19.3.0 documentation</a>
</li>
<li>
<a href="HttpRequest.html">HttpRequest</a>
</li>
</ul>
<h1>Interface HttpRequest</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>An HttpRequest is stack allocated and only accessible during the callback invocation.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">HttpRequest</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 ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#forEach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#getHeader" class="tsd-kind-icon">get<wbr>Header</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#getMethod" class="tsd-kind-icon">get<wbr>Method</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#getParameter" class="tsd-kind-icon">get<wbr>Parameter</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#getQuery" class="tsd-kind-icon">get<wbr>Query</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#getUrl" class="tsd-kind-icon">get<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="HttpRequest.html#setYield" class="tsd-kind-icon">set<wbr>Yield</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="forEach" class="tsd-anchor"></a>
<h3>for<wbr>Each</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">for<wbr>Each<span class="tsd-signature-symbol">(</span>cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L223">index.d.ts:223</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Loops over all headers.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cb: <span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">string</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 <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getHeader" class="tsd-anchor"></a>
<h3>get<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Header<span class="tsd-signature-symbol">(</span>lowerCaseKey<span class="tsd-signature-symbol">: </span><a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L211">index.d.ts:211</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the lowercased header value or empty string.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>lowerCaseKey: <a href="../index.html#RecognizedString" class="tsd-signature-type" data-tsd-kind="Type alias">RecognizedString</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getMethod" class="tsd-anchor"></a>
<h3>get<wbr>Method</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Method<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L217">index.d.ts:217</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the HTTP method, useful for &quot;any&quot; routes.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getParameter" class="tsd-anchor"></a>
<h3>get<wbr>Parameter</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Parameter<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L213">index.d.ts:213</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the parsed parameter at index. Corresponds to route.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>index: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getQuery" class="tsd-anchor"></a>
<h3>get<wbr>Query</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Query<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Query<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L219">index.d.ts:219</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the raw querystring (the part of URL after ? sign) or empty string.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L221">index.d.ts:221</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a decoded query parameter value or empty string.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getUrl" class="tsd-anchor"></a>
<h3>get<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L215">index.d.ts:215</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the URL including initial /slash</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="setYield" class="tsd-anchor"></a>
<h3>set<wbr>Yield</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Yield<span class="tsd-signature-symbol">(</span>yield<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HttpRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpRequest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L225">index.d.ts:225</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>yield: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="HttpRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpRequest</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/ListenOptions.html" class="tsd-kind-icon">Listen<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="AppOptions.html" class="tsd-kind-icon">App<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="HttpRequest.html" class="tsd-kind-icon">Http<wbr>Request</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#forEach" class="tsd-kind-icon">for<wbr>Each</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#getHeader" class="tsd-kind-icon">get<wbr>Header</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#getMethod" class="tsd-kind-icon">get<wbr>Method</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#getParameter" class="tsd-kind-icon">get<wbr>Parameter</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#getQuery" class="tsd-kind-icon">get<wbr>Query</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#getUrl" class="tsd-kind-icon">get<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="HttpRequest.html#setYield" class="tsd-kind-icon">set<wbr>Yield</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="HttpResponse.html" class="tsd-kind-icon">Http<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="MultipartField.html" class="tsd-kind-icon">Multipart<wbr>Field</a>
</li>
<li class=" tsd-kind-interface">
<a href="TemplatedApp.html" class="tsd-kind-icon">Templated<wbr>App</a>
</li>
<li class=" tsd-kind-interface">
<a href="WebSocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="WebSocketBehavior.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Behavior</a>
</li>
<li class=" tsd-kind-interface">
<a href="us_listen_socket.html" class="tsd-kind-icon">us_<wbr>listen_<wbr>socket</a>
</li>
<li class=" tsd-kind-interface">
<a href="us_socket.html" class="tsd-kind-icon">us_<wbr>socket</a>
</li>
<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>
<li class=" tsd-kind-type-alias">
<a href="../index.html#CompressOptions" class="tsd-kind-icon">Compress<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#RecognizedString" class="tsd-kind-icon">Recognized<wbr>String</a>
</li>
<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>
<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>
<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>
<li class=" tsd-kind-function">
<a href="../index.html#getParts" class="tsd-kind-icon">get<wbr>Parts</a>
</li>
<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>
<li class=" tsd-kind-function">
<a href="../index.html#us_socket_local_port" class="tsd-kind-icon">us_<wbr>socket_<wbr>local_<wbr>port</a>
</li>
</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">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>