CommunitySolidServer/docs/interfaces/_util_headerutil_.accept.html
2020-12-20 13:19:19 +00:00

296 lines
14 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Accept | Community Solid Server</title>
<meta name="description" content="Documentation for Community Solid Server">
<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">Community Solid Server</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/_util_headerutil_.html">&quot;util/HeaderUtil&quot;</a>
</li>
<li>
<a href="_util_headerutil_.accept.html">Accept</a>
</li>
</ul>
<h1>Interface Accept</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>Contents of an HTTP Accept header.
Range is type/subtype. Both can be <code>*</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_util_headerutil_.acceptheader.html" class="tsd-signature-type">AcceptHeader</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Accept</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="_util_headerutil_.accept.html#parameters" class="tsd-kind-icon">parameters</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_util_headerutil_.accept.html#range" class="tsd-kind-icon">range</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_util_headerutil_.accept.html#weight" class="tsd-kind-icon">weight</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="parameters" class="tsd-anchor"></a>
<h3>parameters</h3>
<div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>mediaType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/util/HeaderUtil.ts#L70">src/util/HeaderUtil.ts:70</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Extension parameters. These are the parameters that came after the q value.
Value will be an empty string if there was none.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>media<wbr>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Media type parameters. These are the parameters that came before the q value.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="range" class="tsd-anchor"></a>
<h3>range</h3>
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_util_headerutil_.acceptheader.html">AcceptHeader</a>.<a href="_util_headerutil_.acceptheader.html#range">range</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/util/HeaderUtil.ts#L60">src/util/HeaderUtil.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Requested range. Can be a specific value or <code>*</code>, matching all.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="weight" class="tsd-anchor"></a>
<h3>weight</h3>
<div class="tsd-signature tsd-kind-icon">weight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_util_headerutil_.acceptheader.html">AcceptHeader</a>.<a href="_util_headerutil_.acceptheader.html#weight">weight</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/util/HeaderUtil.ts#L62">src/util/HeaderUtil.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Weight of the preference [0, 1].</p>
</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>
<li class="current tsd-kind-module">
<a href="../modules/_util_headerutil_.html">&quot;util/<wbr>Header<wbr>Util&quot;</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 tsd-parent-kind-module">
<a href="_util_headerutil_.accept.html" class="tsd-kind-icon">Accept</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_util_headerutil_.accept.html#parameters" class="tsd-kind-icon">parameters</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_util_headerutil_.accept.html#range" class="tsd-kind-icon">range</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_util_headerutil_.accept.html#weight" class="tsd-kind-icon">weight</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_util_headerutil_.acceptcharset.html" class="tsd-kind-icon">Accept<wbr>Charset</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_util_headerutil_.acceptencoding.html" class="tsd-kind-icon">Accept<wbr>Encoding</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_util_headerutil_.acceptheader.html" class="tsd-kind-icon">Accept<wbr>Header</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_util_headerutil_.acceptlanguage.html" class="tsd-kind-icon">Accept<wbr>Language</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_util_headerutil_.forwarded.html" class="tsd-kind-icon">Forwarded</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_util_headerutil_.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_util_headerutil_.html#token" class="tsd-kind-icon">token</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#addheader" class="tsd-kind-icon">add<wbr>Header</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseaccept" class="tsd-kind-icon">parse<wbr>Accept</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseacceptcharset" class="tsd-kind-icon">parse<wbr>Accept<wbr>Charset</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseacceptencoding" class="tsd-kind-icon">parse<wbr>Accept<wbr>Encoding</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseacceptlanguage" class="tsd-kind-icon">parse<wbr>Accept<wbr>Language</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_util_headerutil_.html#parseacceptpart" class="tsd-kind-icon">parse<wbr>Accept<wbr>Part</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseforwarded" class="tsd-kind-icon">parse<wbr>Forwarded</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_util_headerutil_.html#parsenoparameters" class="tsd-kind-icon">parse<wbr>NoParameters</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#parseparameters" class="tsd-kind-icon">parse<wbr>Parameters</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#splitandclean" class="tsd-kind-icon">split<wbr>And<wbr>Clean</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_util_headerutil_.html#testqvalue" class="tsd-kind-icon">testQValue</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_util_headerutil_.html#transformquotedstrings" class="tsd-kind-icon">transform<wbr>Quoted<wbr>Strings</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<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-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>