mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
493 lines
35 KiB
HTML
493 lines
35 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ErrorToTemplateConverter | Community Solid Server - v1.0.0-beta.2</title>
|
|
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
|
|
<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.2</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.2</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/storage_conversion_errortotemplateconverter.html">storage/conversion/ErrorToTemplateConverter</a>
|
|
</li>
|
|
<li>
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html">ErrorToTemplateConverter</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class ErrorToTemplateConverter</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>Serializes an Error by filling in the provided template.
|
|
Content-type is based on the constructor parameter.</p>
|
|
</div>
|
|
<p>In case the input Error has an <code>errorCode</code> value,
|
|
the converter will look in the <code>descriptions</code> for a file
|
|
with the exact same name as that error code + <code>extension</code>.
|
|
The templating engine will then be applied to that file.
|
|
That result will be passed as an additional parameter to the main templating call,
|
|
using the variable <code>codeMessage</code>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html" class="tsd-signature-type" data-tsd-kind="Class">TypedRepresentationConverter</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">ErrorToTemplateConverter</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#codetemplatespath" class="tsd-kind-icon">code<wbr>Templates<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#extension" class="tsd-kind-icon">extension</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#inputtypes" class="tsd-kind-icon">input<wbr>Types</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#maintemplatepath" class="tsd-kind-icon">main<wbr>Template<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#outputtypes" class="tsd-kind-icon">output<wbr>Types</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#templateengine" class="tsd-kind-icon">template<wbr>Engine</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#getinputtypes" class="tsd-kind-icon">get<wbr>Input<wbr>Types</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#getoutputtypes" class="tsd-kind-icon">get<wbr>Output<wbr>Types</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handle" class="tsd-kind-icon">handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Error<wbr>ToTemplate<wbr>Converter<span class="tsd-signature-symbol">(</span>templateEngine<span class="tsd-signature-symbol">: </span><a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span>, templateOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conversion_errortotemplateconverter.templateoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorToTemplateConverter</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L43">src/storage/conversion/ErrorToTemplateConverter.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>templateEngine: <a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> templateOptions: <a href="../interfaces/storage_conversion_errortotemplateconverter.templateoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateOptions</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorToTemplateConverter</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="codetemplatespath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> code<wbr>Templates<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">code<wbr>Templates<wbr>Path<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/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L41">src/storage/conversion/ErrorToTemplateConverter.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="contenttype" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> content<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">content<wbr>Type<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/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L43">src/storage/conversion/ErrorToTemplateConverter.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="extension" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> extension</h3>
|
|
<div class="tsd-signature tsd-kind-icon">extension<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/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L42">src/storage/conversion/ErrorToTemplateConverter.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a name="inputtypes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> input<wbr>Types</h3>
|
|
<div class="tsd-signature tsd-kind-icon">input<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#inputtypes">inputTypes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/TypedRepresentationConverter.ts#L28">src/storage/conversion/TypedRepresentationConverter.ts:28</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="maintemplatepath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> main<wbr>Template<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">main<wbr>Template<wbr>Path<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/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L40">src/storage/conversion/ErrorToTemplateConverter.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a name="outputtypes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> output<wbr>Types</h3>
|
|
<div class="tsd-signature tsd-kind-icon">output<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#outputtypes">outputTypes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/TypedRepresentationConverter.ts#L29">src/storage/conversion/TypedRepresentationConverter.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="templateengine" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> template<wbr>Engine</h3>
|
|
<div class="tsd-signature tsd-kind-icon">template<wbr>Engine<span class="tsd-signature-symbol">:</span> <a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><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/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L39">src/storage/conversion/ErrorToTemplateConverter.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="canhandle" class="tsd-anchor"></a>
|
|
<h3>can<wbr>Handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</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">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#canhandle">canHandle</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/TypedRepresentationConverter.ts#L59">src/storage/conversion/TypedRepresentationConverter.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Determines whether the given conversion request is supported,
|
|
given the available content type conversions:</p>
|
|
<ul>
|
|
<li>Checks if there is a content type for the input.</li>
|
|
<li>Checks if the input type is supported by the parser.</li>
|
|
<li>Checks if the parser can produce one of the preferred output types.
|
|
Throws an error with details if conversion is not possible.</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>args: <a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</a></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-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getinputtypes" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Input<wbr>Types</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Input<wbr>Types<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><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#getinputtypes">getInputTypes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/TypedRepresentationConverter.ts#L40">src/storage/conversion/TypedRepresentationConverter.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Gets the supported input content types for this converter, mapped to a numerical priority.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="getoutputtypes" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Output<wbr>Types</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Output<wbr>Types<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><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#getoutputtypes">getOutputTypes</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/TypedRepresentationConverter.ts#L47">src/storage/conversion/TypedRepresentationConverter.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Gets the supported output content types for this converter, mapped to a numerical quality.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/ldp_representation_representationpreferences.html#valuepreferences" class="tsd-signature-type" data-tsd-kind="Type alias">ValuePreferences</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<a name="handle" class="tsd-anchor"></a>
|
|
<h3>handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</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><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#handle">handle</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/conversion/ErrorToTemplateConverter.ts#L58">src/storage/conversion/ErrorToTemplateConverter.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Handles the given input. This should only be done if the <a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#canhandle">canHandle</a> function returned <code>true</code>.
|
|
Therefore, consider using the <a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handlesafe">handleSafe</a> function instead.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>A promise resolving when the handling is finished. Return value depends on the given type.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="handlesafe" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Safe</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</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><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html">TypedRepresentationConverter</a>.<a href="storage_conversion_typedrepresentationconverter.typedrepresentationconverter.html#handlesafe">handleSafe</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Helper function that first runs the canHandle function followed by the handle function.
|
|
Throws the error of the <a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#canhandle">canHandle</a> function if the data can't be handled,
|
|
or returns the result of the <a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handle">handle</a> function otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <a href="../interfaces/storage_conversion_representationconverter.representationconverterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationConverterArgs</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Input data that will be handled if it can be handled.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>A promise resolving if the input can be handled, rejecting with an Error if not.
|
|
Return value depends on the given type.</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="../modules/storage_conversion_errortotemplateconverter.html">storage/conversion/<wbr>Error<wbr>ToTemplate<wbr>Converter</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html" class="tsd-kind-icon">Error<wbr>ToTemplate<wbr>Converter</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#codetemplatespath" class="tsd-kind-icon">code<wbr>Templates<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#extension" class="tsd-kind-icon">extension</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#inputtypes" class="tsd-kind-icon">input<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#maintemplatepath" class="tsd-kind-icon">main<wbr>Template<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#outputtypes" class="tsd-kind-icon">output<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#templateengine" class="tsd-kind-icon">template<wbr>Engine</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#getinputtypes" class="tsd-kind-icon">get<wbr>Input<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#getoutputtypes" class="tsd-kind-icon">get<wbr>Output<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handle" class="tsd-kind-icon">handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="storage_conversion_errortotemplateconverter.errortotemplateconverter.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/storage_conversion_errortotemplateconverter.templateoptions.html" class="tsd-kind-icon">Template<wbr>Options</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-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>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</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-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-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-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |