mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
465 lines
27 KiB
HTML
465 lines
27 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>storage/conversion/ConversionUtil | Community Solid Server - v1.0.0-beta.0</title>
|
|
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></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.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 - v1.0.0-beta.0</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>
|
|
</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="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
|
|
</li>
|
|
<li>
|
|
<a href="storage_conversion_conversionutil.html">storage/conversion/ConversionUtil</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module storage/conversion/ConversionUtil</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>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#cleanpreferences" class="tsd-kind-icon">clean<wbr>Preferences</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#getbestpreference" class="tsd-kind-icon">get<wbr>Best<wbr>Preference</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#getconversiontarget" class="tsd-kind-icon">get<wbr>Conversion<wbr>Target</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#gettypeweight" class="tsd-kind-icon">get<wbr>Type<wbr>Weight</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#getweightedpreferences" class="tsd-kind-icon">get<wbr>Weighted<wbr>Preferences</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#isinternalcontenttype" class="tsd-kind-icon">is<wbr>Internal<wbr>Content<wbr>Type</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#matchesmediapreferences" class="tsd-kind-icon">matches<wbr>Media<wbr>Preferences</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="storage_conversion_conversionutil.html#matchesmediatype" class="tsd-kind-icon">matches<wbr>Media<wbr>Type</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="cleanpreferences" class="tsd-anchor"></a>
|
|
<h3>clean<wbr>Preferences</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">clean<wbr>Preferences<span class="tsd-signature-symbol">(</span>preferences<span class="tsd-signature-symbol">?: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L14">src/storage/conversion/ConversionUtil.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Cleans incoming preferences to prevent unwanted behaviour.
|
|
Makes sure internal types have weight 0, unless specifically requested in the preferences,
|
|
and interprets empty preferences as accepting everything.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>preferences: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences that need to be updated.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h4>
|
|
<p>A copy of the the preferences with the necessary updates.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getbestpreference" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Best<wbr>Preference</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Best<wbr>Preference<span class="tsd-signature-symbol">(</span>types<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a>, preferred<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreference" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreference</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L84">src/storage/conversion/ConversionUtil.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Finds the type from the given types that has the best match with the given preferences,
|
|
based on the calculated weight.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>types: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Types for which we want to find the best match.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>preferred: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences to match the types against.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_representationpreferences.html#valuepreference" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreference</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
|
<p>A <a href="ldp_representation_representationpreferences.html#valuepreference">ValuePreference</a> containing the best match and the corresponding weight.
|
|
Undefined if there is no match.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getconversiontarget" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Conversion<wbr>Target</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Conversion<wbr>Target<span class="tsd-signature-symbol">(</span>types<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a>, preferred<span class="tsd-signature-symbol">?: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L117">src/storage/conversion/ConversionUtil.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>For a media type converter that can generate the given types,
|
|
this function tries to find the type that best matches the given preferences.</p>
|
|
</div>
|
|
<p>This function combines several other conversion utility functions
|
|
to determine what output a converter should generate:
|
|
it cleans the preferences with <a href="storage_conversion_conversionutil.html#cleanpreferences">cleanPreferences</a> to support empty preferences
|
|
and to prevent the accidental generation of internal types,
|
|
after which the best match gets found based on the weights.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>types: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Media types that can be converted to.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>preferred: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences for output type.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
|
<p>The best match. Undefined if there is no match.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="gettypeweight" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Type<wbr>Weight</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Type<wbr>Weight<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, preferred<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L36">src/storage/conversion/ConversionUtil.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Tries to match the given type to the given preferences.
|
|
In case there are multiple matches the most specific one will be chosen as per RFC 7231.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Type for which the matching weight is needed.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>preferred: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences to match the type to.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>The corresponding weight from the preferences or 0 if there is no match.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getweightedpreferences" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Weighted<wbr>Preferences</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Weighted<wbr>Preferences<span class="tsd-signature-symbol">(</span>types<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a>, preferred<span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ldp_representation_representationpreferences.html#valuepreference" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreference</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/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L63">src/storage/conversion/ConversionUtil.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Measures the weights for all the given types when matched against the given preferences.
|
|
Results will be sorted by weight.
|
|
Weights of 0 indicate that no match is possible.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>types: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Types for which we want to calculate the weights.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>preferred: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences to match the types against.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_representationpreferences.html#valuepreference" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreference</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
<p>An array with a <a href="ldp_representation_representationpreferences.html#valuepreference">ValuePreference</a> object for every input type, sorted by calculated weight.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="isinternalcontenttype" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Internal<wbr>Content<wbr>Type</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Internal<wbr>Content<wbr>Type<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-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/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L168">src/storage/conversion/ConversionUtil.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks if the given content type is an internal content type such as internal/quads.
|
|
Response will be <code>false</code> if the input type is undefined.</p>
|
|
</div>
|
|
<p>Do not use this for media ranges.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> contentType: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Type to check.</p>
|
|
</div>
|
|
</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 tsd-parent-kind-module">
|
|
<a name="matchesmediapreferences" class="tsd-anchor"></a>
|
|
<h3>matches<wbr>Media<wbr>Preferences</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">matches<wbr>Media<wbr>Preferences<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, preferred<span class="tsd-signature-symbol">?: </span><a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><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/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L129">src/storage/conversion/ConversionUtil.ts:129</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks if the given type matches the given preferences.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Type to match.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> preferred: <a href="ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Preferences to match against.</p>
|
|
</div>
|
|
</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 tsd-parent-kind-module">
|
|
<a name="matchesmediatype" class="tsd-anchor"></a>
|
|
<h3>matches<wbr>Media<wbr>Type</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">matches<wbr>Media<wbr>Type<span class="tsd-signature-symbol">(</span>mediaA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mediaB<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/solid/community-server/blob/d01382d/src/storage/conversion/ConversionUtil.ts#L141">src/storage/conversion/ConversionUtil.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks if the given two media types/ranges match each other.
|
|
Takes wildcards into account.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>mediaA: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Media type to match.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>mediaB: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Media type to match.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>True if the media type patterns can match each other.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="storage_conversion_conversionutil.html">storage/conversion/<wbr>Conversion<wbr>Util</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#cleanpreferences" class="tsd-kind-icon">clean<wbr>Preferences</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#getbestpreference" class="tsd-kind-icon">get<wbr>Best<wbr>Preference</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#getconversiontarget" class="tsd-kind-icon">get<wbr>Conversion<wbr>Target</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#gettypeweight" class="tsd-kind-icon">get<wbr>Type<wbr>Weight</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#getweightedpreferences" class="tsd-kind-icon">get<wbr>Weighted<wbr>Preferences</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#isinternalcontenttype" class="tsd-kind-icon">is<wbr>Internal<wbr>Content<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#matchesmediapreferences" class="tsd-kind-icon">matches<wbr>Media<wbr>Preferences</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="storage_conversion_conversionutil.html#matchesmediatype" class="tsd-kind-icon">matches<wbr>Media<wbr>Type</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-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>
|
|
</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> |