pagespeed-quest
Version:
A framework for efficient web front-end speed improvement
773 lines • 70.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>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>
</ul>
<h1>pagespeed-quest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/inventoryrepository.html" class="tsd-kind-icon">Inventory<wbr>Repository</a></li>
<li class="tsd-kind-class"><a href="classes/playbackproxy.html" class="tsd-kind-icon">Playback<wbr>Proxy</a></li>
<li class="tsd-kind-class"><a href="classes/proxy.html" class="tsd-kind-icon">Proxy</a></li>
<li class="tsd-kind-class"><a href="classes/recordingproxy.html" class="tsd-kind-icon">Recording<wbr>Proxy</a></li>
<li class="tsd-kind-class"><a href="classes/testproxy.html" class="tsd-kind-icon">Test<wbr>Proxy</a></li>
<li class="tsd-kind-class"><a href="classes/throttle.html" class="tsd-kind-icon">Throttle</a></li>
<li class="tsd-kind-class"><a href="classes/throttlinglog.html" class="tsd-kind-icon">Throttling<wbr>Log</a></li>
<li class="tsd-kind-class"><a href="classes/throttlingtransform.html" class="tsd-kind-icon">Throttling<wbr>Transform</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/beautifyresult.html" class="tsd-kind-icon">Beautify<wbr>Result</a></li>
<li class="tsd-kind-interface"><a href="interfaces/contentencodingpair.html" class="tsd-kind-icon">Content<wbr>Encoding<wbr>Pair</a></li>
<li class="tsd-kind-interface"><a href="interfaces/inventory.html" class="tsd-kind-icon">Inventory</a></li>
<li class="tsd-kind-interface"><a href="interfaces/lighthouseoptions.html" class="tsd-kind-icon">Lighthouse<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/playbacktransaction.html" class="tsd-kind-icon">Playback<wbr>Transaction</a></li>
<li class="tsd-kind-interface"><a href="interfaces/proxyoptions.html" class="tsd-kind-icon">Proxy<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/recordingsession.html" class="tsd-kind-icon">Recording<wbr>Session</a></li>
<li class="tsd-kind-interface"><a href="interfaces/recordingtransaction.html" class="tsd-kind-icon">Recording<wbr>Transaction</a></li>
<li class="tsd-kind-interface"><a href="interfaces/resource.html" class="tsd-kind-icon">Resource</a></li>
<li class="tsd-kind-interface"><a href="interfaces/transaction.html" class="tsd-kind-icon">Transaction</a></li>
<li class="tsd-kind-interface"><a href="interfaces/withproxyoptions.html" class="tsd-kind-icon">With<wbr>Proxy<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="globals.html#contentencodingtype" class="tsd-kind-icon">Content<wbr>Encoding<wbr>Type</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#formfactortype" class="tsd-kind-icon">Form<wbr>Factor<wbr>Type</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#httpheaders" class="tsd-kind-icon">Http<wbr>Headers</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="globals.html#basenamemaxlength" class="tsd-kind-icon">Basename<wbr>Max<wbr>Length</a></li>
<li class="tsd-kind-variable"><a href="globals.html#chunksize" class="tsd-kind-icon">Chunk<wbr>Size</a></li>
<li class="tsd-kind-variable"><a href="globals.html#contentencodingmap" class="tsd-kind-icon">Content<wbr>Encoding<wbr>Map</a></li>
<li class="tsd-kind-variable"><a href="globals.html#directoryindex" class="tsd-kind-icon">Directory<wbr>Index</a></li>
<li class="tsd-kind-variable"><a href="globals.html#hashlength" class="tsd-kind-icon">Hash<wbr>Length</a></li>
<li class="tsd-kind-variable"><a href="globals.html#ignoreparams" class="tsd-kind-icon">Ignore<wbr>Params</a></li>
<li class="tsd-kind-variable"><a href="globals.html#ignoreparamsregex" class="tsd-kind-icon">Ignore<wbr>Params<wbr>Regex</a></li>
<li class="tsd-kind-variable"><a href="globals.html#indexfile" class="tsd-kind-icon">Index<wbr>File</a></li>
<li class="tsd-kind-variable"><a href="globals.html#inventorydir" class="tsd-kind-icon">Inventory<wbr>Dir</a></li>
<li class="tsd-kind-variable"><a href="globals.html#main" class="tsd-kind-icon">main</a></li>
<li class="tsd-kind-variable"><a href="globals.html#singleton" class="tsd-kind-icon">singleton</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="globals.html#compress" class="tsd-kind-icon">compress</a></li>
<li class="tsd-kind-function"><a href="globals.html#converteditabletext" class="tsd-kind-icon">convert<wbr>Editable<wbr>Text</a></li>
<li class="tsd-kind-function"><a href="globals.html#decompress" class="tsd-kind-icon">decompress</a></li>
<li class="tsd-kind-function"><a href="globals.html#ensureutf8string" class="tsd-kind-icon">ensure<wbr>Utf8<wbr>String</a></li>
<li class="tsd-kind-function"><a href="globals.html#iscss" class="tsd-kind-icon">is<wbr>Css</a></li>
<li class="tsd-kind-function"><a href="globals.html#ishtml" class="tsd-kind-icon">is<wbr>Html</a></li>
<li class="tsd-kind-function"><a href="globals.html#isjs" class="tsd-kind-icon">is<wbr>Js</a></li>
<li class="tsd-kind-function"><a href="globals.html#istext" class="tsd-kind-icon">is<wbr>Text</a></li>
<li class="tsd-kind-function"><a href="globals.html#lighthousecommands" class="tsd-kind-icon">lighthouse<wbr>Commands</a></li>
<li class="tsd-kind-function"><a href="globals.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-function"><a href="globals.html#normalizeurl" class="tsd-kind-icon">normalize<wbr>Url</a></li>
<li class="tsd-kind-function"><a href="globals.html#parsecontenttypeheader" class="tsd-kind-icon">parse<wbr>Content<wbr>Type<wbr>Header</a></li>
<li class="tsd-kind-function"><a href="globals.html#playback" class="tsd-kind-icon">playback</a></li>
<li class="tsd-kind-function"><a href="globals.html#proxycommands" class="tsd-kind-icon">proxy<wbr>Commands</a></li>
<li class="tsd-kind-function"><a href="globals.html#recording" class="tsd-kind-icon">recording</a></li>
<li class="tsd-kind-function"><a href="globals.html#requestcontentfilepath" class="tsd-kind-icon">request<wbr>Content<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-function"><a href="globals.html#runlighthouse" class="tsd-kind-icon">run<wbr>Lighthouse</a></li>
<li class="tsd-kind-function"><a href="globals.html#stringifycontenttypeheader" class="tsd-kind-icon">stringify<wbr>Content<wbr>Type<wbr>Header</a></li>
<li class="tsd-kind-function"><a href="globals.html#withplaybackproxy" class="tsd-kind-icon">with<wbr>Playback<wbr>Proxy</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#withproxy" class="tsd-kind-icon">with<wbr>Proxy</a></li>
<li class="tsd-kind-function"><a href="globals.html#withrecordingproxy" class="tsd-kind-icon">with<wbr>Recording<wbr>Proxy</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal"><a href="globals.html#prettierdefaultoptions" class="tsd-kind-icon">Prettier<wbr>Default<wbr>Options</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="contentencodingtype" class="tsd-anchor"></a>
<h3>Content<wbr>Encoding<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Content<wbr>Encoding<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"gzip"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"compress"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deflate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"br"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"identity"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/encoding.ts#L3">src/encoding.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="formfactortype" class="tsd-anchor"></a>
<h3>Form<wbr>Factor<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Form<wbr>Factor<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"mobile"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"desktop"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/command.ts#L11">src/command.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="httpheaders" class="tsd-anchor"></a>
<h3>Http<wbr>Headers</h3>
<div class="tsd-signature tsd-kind-icon">Http<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L10">src/http.ts:10</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>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="basenamemaxlength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Basename<wbr>Max<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">Basename<wbr>Max<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">196</span><span class="tsd-signature-symbol"> = 196</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L5">src/http.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="chunksize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Chunk<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">Chunk<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1024 * 16</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/playback.ts#L6">src/playback.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="contentencodingmap" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Content<wbr>Encoding<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">Content<wbr>Encoding<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><a href="globals.html#contentencodingtype" class="tsd-signature-type">ContentEncodingType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/contentencodingpair.html" class="tsd-signature-type">ContentEncodingPair</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map<ContentEncodingType, ContentEncodingPair>()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/encoding.ts#L10">src/encoding.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="directoryindex" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Directory<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">Directory<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"index.html"</span><span class="tsd-signature-symbol"> = "index.html"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L4">src/http.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="hashlength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Hash<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">Hash<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">8</span><span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L6">src/http.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="ignoreparams" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Ignore<wbr>Params</h3>
<div class="tsd-signature tsd-kind-icon">Ignore<wbr>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.env.IGNORE_PARAMS || 'ts'</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L7">src/http.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="ignoreparamsregex" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Ignore<wbr>Params<wbr>Regex</h3>
<div class="tsd-signature tsd-kind-icon">Ignore<wbr>Params<wbr>Regex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = IgnoreParams.split(/\s*,\s*/).map((p) => new RegExp(`(?<=[?&]${p}=)[^&]*`, 'g'))</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L8">src/http.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="indexfile" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Index<wbr>File</h3>
<div class="tsd-signature tsd-kind-icon">Index<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"index.json"</span><span class="tsd-signature-symbol"> = "index.json"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/inventory.ts#L11">src/inventory.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="inventorydir" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Inventory<wbr>Dir</h3>
<div class="tsd-signature tsd-kind-icon">Inventory<wbr>Dir<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"inventory"</span><span class="tsd-signature-symbol"> = "inventory"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/inventory.ts#L10">src/inventory.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="main" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> main</h3>
<div class="tsd-signature tsd-kind-icon">main<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Command</span><span class="tsd-signature-symbol"> = new Command()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/command.ts#L53">src/command.ts:53</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="singleton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> singleton</h3>
<div class="tsd-signature tsd-kind-icon">singleton<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = Pino({transport: {target: 'pino-pretty',options: {levelFirst: true,hideObject: Boolean(!process.env.LOG_OBJECTS),},},level: process.env.LOG_LEVEL || 'info',})</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/logger.ts#L3">src/logger.ts:3</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="compress" class="tsd-anchor"></a>
<h3>compress</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">compress<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#contentencodingtype" class="tsd-signature-type">ContentEncodingType</a>, buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/encoding.ts#L32">src/encoding.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <a href="globals.html#contentencodingtype" class="tsd-signature-type">ContentEncodingType</a></h5>
</li>
<li>
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="converteditabletext" class="tsd-anchor"></a>
<h3>convert<wbr>Editable<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">convert<wbr>Editable<wbr>Text<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, contentTypeMime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contentTypeCharset<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L38">src/formatting.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>content: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>contentTypeMime: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> contentTypeCharset: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="decompress" class="tsd-anchor"></a>
<h3>decompress</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">decompress<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="globals.html#contentencodingtype" class="tsd-signature-type">ContentEncodingType</a>, buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/encoding.ts#L44">src/encoding.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <a href="globals.html#contentencodingtype" class="tsd-signature-type">ContentEncodingType</a></h5>
</li>
<li>
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="ensureutf8string" class="tsd-anchor"></a>
<h3>ensure<wbr>Utf8<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">ensure<wbr>Utf8<wbr>String<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, charset<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/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L6">src/formatting.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>charset: <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-function">
<a name="iscss" class="tsd-anchor"></a>
<h3>is<wbr>Css</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Css<span class="tsd-signature-symbol">(</span>mimeType<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L17">src/formatting.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mimeType: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="ishtml" class="tsd-anchor"></a>
<h3>is<wbr>Html</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Html<span class="tsd-signature-symbol">(</span>mimeType<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L12">src/formatting.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mimeType: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="isjs" class="tsd-anchor"></a>
<h3>is<wbr>Js</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Js<span class="tsd-signature-symbol">(</span>mimeType<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L22">src/formatting.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mimeType: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="istext" class="tsd-anchor"></a>
<h3>is<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Text<span class="tsd-signature-symbol">(</span>mimeType<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/formatting.ts#L29">src/formatting.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mimeType: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="lighthousecommands" class="tsd-anchor"></a>
<h3>lighthouse<wbr>Commands</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">lighthouse<wbr>Commands<span class="tsd-signature-symbol">(</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/ideamans/pagespeed-quest/blob/8dbbaab/src/command.ts#L55">src/command.ts:55</a></li>
</ul>
</aside>
<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-function">
<a name="logger" class="tsd-anchor"></a>
<h3>logger</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/logger.ts#L14">src/logger.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Logger</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="normalizeurl" class="tsd-anchor"></a>
<h3>normalize<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">normalize<wbr>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URL</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L18">src/http.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Remove IgnoreParams from URL
Default: ts (timestamp) assumed different for each request</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">URL</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="parsecontenttypeheader" class="tsd-anchor"></a>
<h3>parse<wbr>Content<wbr>Type<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Content<wbr>Type<wbr>Header<span class="tsd-signature-symbol">(</span>contentType<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-symbol">{ </span>charset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L91">src/http.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contentType: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>charset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>charset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>mime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="playback" class="tsd-anchor"></a>
<h3>playback</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">playback<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/adhoc.ts#L36">src/adhoc.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="proxycommands" class="tsd-anchor"></a>
<h3>proxy<wbr>Commands</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">proxy<wbr>Commands<span class="tsd-signature-symbol">(</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/ideamans/pagespeed-quest/blob/8dbbaab/src/command.ts#L96">src/command.ts:96</a></li>
</ul>
</aside>
<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-function">
<a name="recording" class="tsd-anchor"></a>
<h3>recording</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">recording<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/adhoc.ts#L20">src/adhoc.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="requestcontentfilepath" class="tsd-anchor"></a>
<h3>request<wbr>Content<wbr>File<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">request<wbr>Content<wbr>File<wbr>Path<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</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/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L41">src/http.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert URL to content file path
For example:
<a href="https://example.com/foo/bar.html?hoge=123">https://example.com/foo/bar.html?hoge=123</a> -> example.com/foo/bar~hoge=123.html</p>
<ul>
<li>Add directory index (index.html) if URL ends with slash</li>
<li>Shorten too long basename with short hash</li>
<li>Ignore dynamic params for example: ts=123</li>
</ul>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>method: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>url: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">URL</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-function">
<a name="runlighthouse" class="tsd-anchor"></a>
<h3>run<wbr>Lighthouse</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">run<wbr>Lighthouse<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/adhoc.ts#L8">src/adhoc.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>port: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="stringifycontenttypeheader" class="tsd-anchor"></a>
<h3>stringify<wbr>Content<wbr>Type<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">stringify<wbr>Content<wbr>Type<wbr>Header<span class="tsd-signature-symbol">(</span>mime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, charset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, original<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/ideamans/pagespeed-quest/blob/8dbbaab/src/http.ts#L100">src/http.ts:100</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> mime: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> charset: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> original: <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-function">
<a name="withplaybackproxy" class="tsd-anchor"></a>
<h3>with<wbr>Playback<wbr>Proxy</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">with<wbr>Playback<wbr>Proxy<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>proxy<span class="tsd-signature-symbol">: </span><a href="classes/playbackproxy.html" class="tsd-signature-type">PlaybackProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="interfaces/withproxyoptions.html" class="tsd-signature-type">WithProxyOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="classes/playbackproxy.html" class="tsd-signature-type">PlaybackProxy</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/playback.ts#L135">src/playback.ts:135</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-symbol">(</span>proxy<span class="tsd-signature-symbol">: </span><a href="classes/playbackproxy.html" class="tsd-signature-type">PlaybackProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>proxy<span class="tsd-signature-symbol">: </span><a href="classes/playbackproxy.html" class="tsd-signature-type">PlaybackProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions