UNPKG

express-mesh

Version:

A Gentics Mesh frontend for Express.

793 lines 123 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IMeshRequest | ExpressMesh</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script src="../assets/js/modernizr.js"></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.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">ExpressMesh</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-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_lib_mesh_.html">&quot;lib/mesh&quot;</a> </li> <li> <a href="_lib_mesh_.imeshrequest.html">IMeshRequest</a> </li> </ul> <h1>Interface IMeshRequest</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>Wrapper for the express.Request. We can use them to add properties to the request.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="tsd-signature-type">Request</span> <ul class="tsd-hierarchy"> <li> <span class="target">IMeshRequest</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><span class="tsd-signature-type">EventEmitter</span></li> <li><span class="tsd-signature-type">ReadableStream</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-inherited"> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#accepted" class="tsd-kind-icon">accepted</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#acceptedcharsets" class="tsd-kind-icon">accepted<wbr>Charsets</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#acceptedlanguages" class="tsd-kind-icon">accepted<wbr>Languages</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#authenticateduser" class="tsd-kind-icon">authenticated<wbr>User</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#body" class="tsd-kind-icon">body</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#connection" class="tsd-kind-icon">connection</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#cookies" class="tsd-kind-icon">cookies</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#fresh" class="tsd-kind-icon">fresh</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#headers" class="tsd-kind-icon">headers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#host" class="tsd-kind-icon">host</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#hostname" class="tsd-kind-icon">hostname</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#httpversion" class="tsd-kind-icon">http<wbr>Version</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#ip" class="tsd-kind-icon">ip</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#ips" class="tsd-kind-icon">ips</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_mesh_.imeshrequest.html#meshconfig" class="tsd-kind-icon">mesh<wbr>Config</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#method" class="tsd-kind-icon">method</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#originalurl" class="tsd-kind-icon">original<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#params" class="tsd-kind-icon">params</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#path" class="tsd-kind-icon">path</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#protocol" class="tsd-kind-icon">protocol</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#query" class="tsd-kind-icon">query</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#rawheaders" class="tsd-kind-icon">raw<wbr>Headers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#rawtrailers" class="tsd-kind-icon">raw<wbr>Trailers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#readable" class="tsd-kind-icon">readable</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_mesh_.imeshrequest.html#requestednode" class="tsd-kind-icon">requested<wbr>Node</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#route" class="tsd-kind-icon">route</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#secure" class="tsd-kind-icon">secure</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#session" class="tsd-kind-icon">session</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#signedcookies" class="tsd-kind-icon">signed<wbr>Cookies</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#socket" class="tsd-kind-icon">socket</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#stale" class="tsd-kind-icon">stale</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#statuscode" class="tsd-kind-icon">status<wbr>Code</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#statusmessage" class="tsd-kind-icon">status<wbr>Message</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#subdomains" class="tsd-kind-icon">subdomains</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#trailers" class="tsd-kind-icon">trailers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#url" class="tsd-kind-icon">url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#user" class="tsd-kind-icon">user</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#xhr" class="tsd-kind-icon">xhr</a></li> </ul> </section> <section class="tsd-index-section tsd-is-inherited"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#_read" class="tsd-kind-icon">_read</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#accepts" class="tsd-kind-icon">accepts</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#acceptscharset" class="tsd-kind-icon">accepts<wbr>Charset</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#acceptslanguage" class="tsd-kind-icon">accepts<wbr>Language</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#clearcookie" class="tsd-kind-icon">clear<wbr>Cookie</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#emit" class="tsd-kind-icon">emit</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#get" class="tsd-kind-icon">get</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#header" class="tsd-kind-icon">header</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#is" class="tsd-kind-icon">is</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#listeners" class="tsd-kind-icon">listeners</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#on" class="tsd-kind-icon">on</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#once" class="tsd-kind-icon">once</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#param" class="tsd-kind-icon">param</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#pause" class="tsd-kind-icon">pause</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#pipe" class="tsd-kind-icon">pipe</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#push" class="tsd-kind-icon">push</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#range" class="tsd-kind-icon">range</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#read" class="tsd-kind-icon">read</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#resume" class="tsd-kind-icon">resume</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#setencoding" class="tsd-kind-icon">set<wbr>Encoding</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#settimeout" class="tsd-kind-icon">set<wbr>Timeout</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#unpipe" class="tsd-kind-icon">unpipe</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#unshift" class="tsd-kind-icon">unshift</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_lib_mesh_.imeshrequest.html#wrap" class="tsd-kind-icon">wrap</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-static"><a href="_lib_mesh_.imeshrequest.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">new IMesh<wbr>Request<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadableOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Readable.__constructor</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L1669">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:1669</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-type">ReadableOptions</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="accepted" class="tsd-anchor"></a> <h3>accepted</h3> <div class="tsd-signature tsd-kind-icon">accepted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaType</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from Request.accepted</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L234">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:234</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return an array of Accepted media types ordered from highest quality to lowest.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="acceptedcharsets" class="tsd-anchor"></a> <h3>accepted<wbr>Charsets</h3> <div class="tsd-signature tsd-kind-icon">accepted<wbr>Charsets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from Request.acceptedCharsets</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L256">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:256</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return an array of Accepted charsets ordered from highest quality to lowest.</p> </div> <p>Examples:</p> <pre><code>Accept-<span class="hljs-string">Charset:</span> iso-<span class="hljs-number">8859</span>-<span class="hljs-number">5</span>;q=<span class="hljs-number">.2</span>, unicode-<span class="hljs-number">1</span>-<span class="hljs-number">1</span>;q=<span class="hljs-number">0.8</span> [<span class="hljs-string">'unicode-1-1'</span>, <span class="hljs-string">'iso-8859-5'</span>] </code></pre> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="acceptedlanguages" class="tsd-anchor"></a> <h3>accepted<wbr>Languages</h3> <div class="tsd-signature tsd-kind-icon">accepted<wbr>Languages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from Request.acceptedLanguages</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L245">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:245</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return an array of Accepted languages ordered from highest quality to lowest.</p> </div> <p>Examples:</p> <pre><code>Accept-Language: <span class="hljs-keyword">en</span>;q=.5, <span class="hljs-keyword">en</span>-<span class="hljs-keyword">us</span> ['<span class="hljs-keyword">en</span>-<span class="hljs-keyword">us</span>', '<span class="hljs-keyword">en</span>'] </code></pre> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="authenticateduser" class="tsd-anchor"></a> <h3>authenticated<wbr>User</h3> <div class="tsd-signature tsd-kind-icon">authenticated<wbr>User<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.authenticatedUser</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L392">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:392</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="body" class="tsd-anchor"></a> <h3>body</h3> <div class="tsd-signature tsd-kind-icon">body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.body</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L381">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:381</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="connection" class="tsd-anchor"></a> <h3>connection</h3> <div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Socket</span></div> <aside class="tsd-sources"> <p>Inherited from ServerRequest.connection</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L442">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:442</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="cookies" class="tsd-anchor"></a> <h3>cookies</h3> <div class="tsd-signature tsd-kind-icon">cookies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.cookies</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L384">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:384</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="fresh" class="tsd-anchor"></a> <h3>fresh</h3> <div class="tsd-signature tsd-kind-icon">fresh<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from Request.fresh</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L366">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:366</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the request is fresh, aka Last-Modified and/or the ETag still match.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <a name="headers" class="tsd-anchor"></a> <h3>headers</h3> <div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <p>Inherited from Request.headers</p> <p>Overwrites IncomingMessage.headers</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L152">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:152</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="host" class="tsd-anchor"></a> <h3>host</h3> <div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.host</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L359">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:359</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd><p>Use hostname instead.</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="hostname" class="tsd-anchor"></a> <h3>hostname</h3> <div class="tsd-signature tsd-kind-icon">hostname<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.hostname</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L354">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:354</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Parse the &quot;Host&quot; header field hostname.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="httpversion" class="tsd-anchor"></a> <h3>http<wbr>Version</h3> <div class="tsd-signature tsd-kind-icon">http<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.httpVersion</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L492">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:492</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="ip" class="tsd-anchor"></a> <h3>ip</h3> <div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.ip</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L321">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:321</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the remote address, or when &quot;trust proxy&quot; is <code>true</code> return the upstream addr.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="ips" class="tsd-anchor"></a> <h3>ips</h3> <div class="tsd-signature tsd-kind-icon">ips<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from Request.ips</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L331">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:331</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>When &quot;trust proxy&quot; is <code>true</code>, parse the &quot;X-Forwarded-For&quot; ip address list.</p> </div> <p>For example if the value were &quot;client, proxy1, proxy2&quot; you would receive the array <code>[&quot;client&quot;, &quot;proxy1&quot;, &quot;proxy2&quot;]</code> where &quot;proxy2&quot; is the furthest down-stream.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="meshconfig" class="tsd-anchor"></a> <h3>mesh<wbr>Config</h3> <div class="tsd-signature tsd-kind-icon">mesh<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="../classes/_lib_config_.meshconfig.html" class="tsd-signature-type">MeshConfig</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L25">lib/mesh.ts:25</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <a name="method" class="tsd-anchor"></a> <h3>method</h3> <div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.method</p> <p>Overwrites IncomingMessage.method</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L386">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:386</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="originalurl" class="tsd-anchor"></a> <h3>original<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">original<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.originalUrl</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L408">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:408</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="params" class="tsd-anchor"></a> <h3>params</h3> <div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.params</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L388">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:388</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="path" class="tsd-anchor"></a> <h3>path</h3> <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.path</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L349">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:349</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Short-hand for <code>url.parse(req.url).pathname</code>.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="protocol" class="tsd-anchor"></a> <h3>protocol</h3> <div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.protocol</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L307">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:307</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the protocol string &quot;http&quot; or &quot;https&quot; when requested with TLS. When the &quot;trust proxy&quot; setting is enabled the &quot;X-Forwarded-Proto&quot; header field will be trusted. If you&#39;re running behind a reverse proxy that supplies https for you this may be enabled.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="query" class="tsd-anchor"></a> <h3>query</h3> <div class="tsd-signature tsd-kind-icon">query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.query</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L402">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:402</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="rawheaders" class="tsd-anchor"></a> <h3>raw<wbr>Headers</h3> <div class="tsd-signature tsd-kind-icon">raw<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.rawHeaders</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L494">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:494</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="rawtrailers" class="tsd-anchor"></a> <h3>raw<wbr>Trailers</h3> <div class="tsd-signature tsd-kind-icon">raw<wbr>Trailers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.rawTrailers</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L496">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:496</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="readable" class="tsd-anchor"></a> <h3>readable</h3> <div class="tsd-signature tsd-kind-icon">readable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from Readable.readable</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L1669">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:1669</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="requestednode" class="tsd-anchor"></a> <h3>requested<wbr>Node</h3> <div class="tsd-signature tsd-kind-icon">requested<wbr>Node<span class="tsd-signature-symbol">:</span> <a href="_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L26">lib/mesh.ts:26</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="route" class="tsd-anchor"></a> <h3>route</h3> <div class="tsd-signature tsd-kind-icon">route<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.route</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L404">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:404</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="secure" class="tsd-anchor"></a> <h3>secure</h3> <div class="tsd-signature tsd-kind-icon">secure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from Request.secure</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L314">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:314</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Short-hand for:</p> </div> <p> req.protocol == &#39;https&#39;</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="session" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> session</h3> <div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Session</span></div> <aside class="tsd-sources"> <p>Inherited from Request.session</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express-session/express-session.d.ts#L11">/home/pgurtler/gentics/git/express-mesh/devtypes/express-session/express-session.d.ts:11</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="signedcookies" class="tsd-anchor"></a> <h3>signed<wbr>Cookies</h3> <div class="tsd-signature tsd-kind-icon">signed<wbr>Cookies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.signedCookies</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L406">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:406</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="socket" class="tsd-anchor"></a> <h3>socket</h3> <div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Socket</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.socket</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L514">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:514</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="stale" class="tsd-anchor"></a> <h3>stale</h3> <div class="tsd-signature tsd-kind-icon">stale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from Request.stale</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L373">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:373</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the request is stale, aka &quot;Last-Modified&quot; and / or the &quot;ETag&quot; for the resource has changed.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="statuscode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> status<wbr>Code</h3> <div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.statusCode</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L509">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:509</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Only valid for response obtained from http.ClientRequest.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="statusmessage" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> status<wbr>Message</h3> <div class="tsd-signature tsd-kind-icon">status<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.statusMessage</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L513">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:513</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Only valid for response obtained from http.ClientRequest.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="subdomains" class="tsd-anchor"></a> <h3>subdomains</h3> <div class="tsd-signature tsd-kind-icon">subdomains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from Request.subdomains</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L344">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:344</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return subdomains as an array.</p> </div> <p>Subdomains are the dot-separated parts of the host before the main domain of the app. By default, the domain of the app is assumed to be the last two parts of the host. This can be changed by setting &quot;subdomain offset&quot;.</p> <p>For example, if the domain is &quot;tobi.ferrets.example.com&quot;: If &quot;subdomain offset&quot; is not set, req.subdomains is <code>[&quot;ferrets&quot;, &quot;tobi&quot;]</code>. If &quot;subdomain offset&quot; is 3, req.subdomains is <code>[&quot;tobi&quot;]</code>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="trailers" class="tsd-anchor"></a> <h3>trailers</h3> <div class="tsd-signature tsd-kind-icon">trailers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from IncomingMessage.trailers</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L495">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:495</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited"> <a name="url" class="tsd-anchor"></a> <h3>url</h3> <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from Request.url</p> <p>Overwrites IncomingMessage.url</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L410">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:410</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="user" class="tsd-anchor"></a> <h3>user</h3> <div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from Request.user</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L390">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:390</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="xhr" class="tsd-anchor"></a> <h3>xhr</h3> <div class="tsd-signature tsd-kind-icon">xhr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from Request.xhr</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/express/express.d.ts#L378">/home/pgurtler/gentics/git/express-mesh/devtypes/express/express.d.ts:378</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the request was an <em>XMLHttpRequest</em>.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <a name="_read" class="tsd-anchor"></a> <h3>_read</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">_read<span class="tsd-signature-symbol">(</span>size<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from Readable._read</p> <ul> <li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/devtypes/node/node.d.ts#L1671">/home/pgurtler/gentics/git/express-mesh/devtypes/node/node.d.ts:1671</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>size: <span class="tsd-signature-type">number</span></h5> </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 tsd-is-inherited"> <a name="accepts" class="tsd-anchor"></a> <h3>accepts</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">accepts<span class="tsd-signature-symbol">(</span>t