This commit is contained in:
RubenVerborgh
2021-06-29 16:54:45 +00:00
parent e1e35a84d0
commit 8591fda008
525 changed files with 12756 additions and 8659 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>util/errors/ErrorUtil | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>util/errors/ErrorUtil | 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>
@@ -23,7 +23,7 @@
<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 - v0.9.0</a>
<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">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v0.9.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
</li>
<li>
<a href="util_errors_errorutil.html">util/errors/ErrorUtil</a>
@@ -72,7 +72,10 @@
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_errors_errorutil.html#isnativeerror" class="tsd-kind-icon">is<wbr>Native<wbr>Error</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_errors_errorutil.html#asserterror" class="tsd-kind-icon">assert<wbr>Error</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_errors_errorutil.html#createerrormessage" class="tsd-kind-icon">create<wbr>Error<wbr>Message</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_errors_errorutil.html#getstatuscode" class="tsd-kind-icon">get<wbr>Status<wbr>Code</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_errors_errorutil.html#iserror" class="tsd-kind-icon">is<wbr>Error</a></li>
</ul>
</section>
</div>
@@ -81,16 +84,96 @@
<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="isnativeerror" class="tsd-anchor"></a>
<h3>is<wbr>Native<wbr>Error</h3>
<a name="asserterror" class="tsd-anchor"></a>
<h3>assert<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">is<wbr>Native<wbr>Error<span class="tsd-signature-symbol">(</span>error<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><span class="tsd-signature-type">error</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Error</span></li>
<li class="tsd-signature tsd-kind-icon">assert<wbr>Error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">asserts </span><span class="tsd-signature-type">error</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Error</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/0a68fbf/src/util/errors/ErrorUtil.ts#L6">src/util/errors/ErrorUtil.ts:6</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/util/errors/ErrorUtil.ts#L19">src/util/errors/ErrorUtil.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Asserts that the input is a native error.
If not the input will be re-thrown.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error: <span class="tsd-signature-type">unknown</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">asserts </span><span class="tsd-signature-type">error</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Error</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="createerrormessage" class="tsd-anchor"></a>
<h3>create<wbr>Error<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">create<wbr>Error<wbr>Message<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</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/solid/community-server/blob/d01382d/src/util/errors/ErrorUtil.ts#L25">src/util/errors/ErrorUtil.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error: <span class="tsd-signature-type">unknown</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 tsd-parent-kind-module">
<a name="getstatuscode" class="tsd-anchor"></a>
<h3>get<wbr>Status<wbr>Code</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<wbr>Code<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><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/util/errors/ErrorUtil.ts#L32">src/util/errors/ErrorUtil.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the HTTP status code corresponding to the error.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error: <span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="iserror" class="tsd-anchor"></a>
<h3>is<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">is<wbr>Error<span class="tsd-signature-symbol">(</span>error<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><span class="tsd-signature-type">error</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Error</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/util/errors/ErrorUtil.ts#L7">src/util/errors/ErrorUtil.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -114,7 +197,7 @@
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="util_errors_errorutil.html">util/errors/<wbr>Error<wbr>Util</a>
@@ -124,7 +207,16 @@
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_errors_errorutil.html#isnativeerror" class="tsd-kind-icon">is<wbr>Native<wbr>Error</a>
<a href="util_errors_errorutil.html#asserterror" class="tsd-kind-icon">assert<wbr>Error</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_errors_errorutil.html#createerrormessage" class="tsd-kind-icon">create<wbr>Error<wbr>Message</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_errors_errorutil.html#getstatuscode" class="tsd-kind-icon">get<wbr>Status<wbr>Code</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_errors_errorutil.html#iserror" class="tsd-kind-icon">is<wbr>Error</a>
</li>
</ul>
</nav>