pagespeed-quest
Version:
A framework for efficient web front-end speed improvement
423 lines • 21.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ProxyOptions | pagespeed-quest</title>
<meta name="description" content="Documentation for pagespeed-quest">
<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.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">pagespeed-quest</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="proxyoptions.html">ProxyOptions</a>
</li>
</ul>
<h1>Interface ProxyOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">IProxyOptions</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ProxyOptions</span>
</li>
</ul>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="proxyoptions.html#entryurl" class="tsd-kind-icon">entry<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#forcechunkedrequest" class="tsd-kind-icon">force<wbr>Chunked<wbr>Request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#forcesni" class="tsd-kind-icon">forceSNI</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#host" class="tsd-kind-icon">host</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#httpagent" class="tsd-kind-icon">http<wbr>Agent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#httpsagent" class="tsd-kind-icon">https<wbr>Agent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#httpsport" class="tsd-kind-icon">https<wbr>Port</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="proxyoptions.html#inventoryrepository" class="tsd-kind-icon">inventory<wbr>Repository</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#keepalive" class="tsd-kind-icon">keep<wbr>Alive</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#sslcadir" class="tsd-kind-icon">ssl<wbr>CaDir</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="proxyoptions.html#throttle" class="tsd-kind-icon">throttle</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="proxyoptions.html#throttlingretryintervalms" class="tsd-kind-icon">throttling<wbr>Retry<wbr>Interval<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="proxyoptions.html#timeout" class="tsd-kind-icon">timeout</a></li>
</ul>
</section>
</div>
</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">
<a name="entryurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> entry<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">entry<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/proxy.ts#L19">src/proxy.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forcechunkedrequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> force<wbr>Chunked<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">force<wbr>Chunked<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#forcechunkedrequest">forceChunkedRequest</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:37</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>Setting this option will remove the content-length from the proxy to server request, forcing chunked encoding</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forcesni" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forceSNI</h3>
<div class="tsd-signature tsd-kind-icon">forceSNI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#forcesni">forceSNI</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>force use of SNI by the client. Allow node-http-mitm-proxy to handle all HTTPS requests with a single internal server.</li>
</ul>
</div>
</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><span class="tsd-flag ts-flagOptional">Optional</span> 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 <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#host">host</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:21</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>host - The hostname or local address to listen on.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="httpagent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> http<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">http<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Agent</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#httpagent">httpAgent</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:29</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>The http.Agent to use when making http requests. Useful for chaining proxys. (default: internal Agent)</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="httpsagent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> https<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">https<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Agent</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#httpsagent">httpsAgent</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:31</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>The https.Agent to use when making https requests. Useful for chaining proxys. (default: internal Agent)</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="httpsport" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> https<wbr>Port</h3>
<div class="tsd-signature tsd-kind-icon">https<wbr>Port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#httpsport">httpsPort</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:35</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>The port or named socket for https server to listen on. (forceSNI must be enabled)</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inventoryrepository" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> inventory<wbr>Repository</h3>
<div class="tsd-signature tsd-kind-icon">inventory<wbr>Repository<span class="tsd-signature-symbol">:</span> <a href="../classes/inventoryrepository.html" class="tsd-signature-type">InventoryRepository</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/proxy.ts#L16">src/proxy.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="keepalive" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> keep<wbr>Alive</h3>
<div class="tsd-signature tsd-kind-icon">keep<wbr>Alive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#keepalive">keepAlive</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:25</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>enable HTTP persistent connection</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="port" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> port</h3>
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#port">port</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:19</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>port - The port or named socket to listen on (default: 8080).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="sslcadir" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ssl<wbr>CaDir</h3>
<div class="tsd-signature tsd-kind-icon">ssl<wbr>CaDir<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#sslcadir">sslCaDir</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:23</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>Path to the certificates cache directory (default: process.cwd() + '/.http-mitm-proxy')</li>
</ul>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="throttle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> throttle</h3>
<div class="tsd-signature tsd-kind-icon">throttle<span class="tsd-signature-symbol">:</span> <a href="../classes/throttle.html" class="tsd-signature-type">Throttle</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/proxy.ts#L17">src/proxy.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="throttlingretryintervalms" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> throttling<wbr>Retry<wbr>Interval<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">throttling<wbr>Retry<wbr>Interval<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/proxy.ts#L18">src/proxy.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="proxyoptions.html">ProxyOptions</a>.<a href="proxyoptions.html#timeout">timeout</a></p>
<ul>
<li>Defined in node_modules/http-mitm-proxy/index.d.ts:27</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<ul>
<li>The number of milliseconds of inactivity before a socket is presumed to have timed out. Defaults to no timeout.</li>
</ul>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="proxyoptions.html" class="tsd-kind-icon">Proxy<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="proxyoptions.html#entryurl" class="tsd-kind-icon">entry<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#forcechunkedrequest" class="tsd-kind-icon">force<wbr>Chunked<wbr>Request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#forcesni" class="tsd-kind-icon">forceSNI</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#host" class="tsd-kind-icon">host</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#httpagent" class="tsd-kind-icon">http<wbr>Agent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#httpsagent" class="tsd-kind-icon">https<wbr>Agent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#httpsport" class="tsd-kind-icon">https<wbr>Port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="proxyoptions.html#inventoryrepository" class="tsd-kind-icon">inventory<wbr>Repository</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#keepalive" class="tsd-kind-icon">keep<wbr>Alive</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#port" class="tsd-kind-icon">port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#sslcadir" class="tsd-kind-icon">ssl<wbr>CaDir</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="proxyoptions.html#throttle" class="tsd-kind-icon">throttle</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="proxyoptions.html#throttlingretryintervalms" class="tsd-kind-icon">throttling<wbr>Retry<wbr>Interval<wbr>Ms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="proxyoptions.html#timeout" class="tsd-kind-icon">timeout</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-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>
</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>