2021-11-04 06:03:14 +00:00
<!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 v20.4.0 documentation< / title > < meta name = "description" content = "Documentation for uWebSockets.js v20.4.0 documentation" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script async src = "../assets/search.js" id = "search-script" > < / script > < / head > < body > < script > document . body . classList . add ( localStorage . getItem ( "tsd-theme" ) || "os" ) < / script > < header > < div class = "tsd-page-toolbar" > < div class = "container" > < div class = "table-wrap" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label > < input type = "text" id = "tsd-search-field" / > < / 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 v20.4.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 v20.4.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 id = "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" > => < / 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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L210" > index.d.ts:210< / 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" > => < / 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L198" > index.d.ts:198< / 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L204" > index.d.ts:204< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Returns the HTTP method, useful for " any" 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L200" > index.d.ts:200< / 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L206" > index.d.ts:206< / 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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L208" > index.d.ts:208< / 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L202" > index.d.ts:202< / 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 id = "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/uNetworking/uWebSockets.js/blob/master/docs/index.d.ts#L212" > index.d.ts:212< / 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 > < 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 > < / 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 > < h2 > Settings< / h2 > < p > Theme < select id = "theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / p > < / 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/main.js" > < / script > < / body > < / html >
