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>AuxiliaryAuthorizer | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>AuxiliaryAuthorizer | 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="../modules/authorization_auxiliaryauthorizer.html">authorization/AuxiliaryAuthorizer</a>
@@ -133,7 +133,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="authorization_authorizer.authorizer.html">Authorizer</a>.<a href="authorization_authorizer.authorizer.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L17">src/authorization/AuxiliaryAuthorizer.ts:17</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L17">src/authorization/AuxiliaryAuthorizer.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -158,7 +158,7 @@
<div class="tsd-signature tsd-kind-icon">aux<wbr>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L17">src/authorization/AuxiliaryAuthorizer.ts:17</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L17">src/authorization/AuxiliaryAuthorizer.ts:17</a></li>
</ul>
</aside>
</section>
@@ -168,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L14">src/authorization/AuxiliaryAuthorizer.ts:14</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L14">src/authorization/AuxiliaryAuthorizer.ts:14</a></li>
</ul>
</aside>
</section>
@@ -178,7 +178,7 @@
<div class="tsd-signature tsd-kind-icon">resource<wbr>Authorizer<span class="tsd-signature-symbol">:</span> <a href="authorization_authorizer.authorizer.html" class="tsd-signature-type" data-tsd-kind="Class">Authorizer</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L16">src/authorization/AuxiliaryAuthorizer.ts:16</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L16">src/authorization/AuxiliaryAuthorizer.ts:16</a></li>
</ul>
</aside>
</section>
@@ -196,9 +196,15 @@
<aside class="tsd-sources">
<p>Overrides <a href="authorization_authorizer.authorizer.html">Authorizer</a>.<a href="authorization_authorizer.authorizer.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L25">src/authorization/AuxiliaryAuthorizer.ts:25</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L25">src/authorization/AuxiliaryAuthorizer.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if the input data can be handled by this class.
Throws an error if it can&#39;t handle the data.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -206,6 +212,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
</li>
</ul>
</section>
@@ -219,7 +226,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L42">src/authorization/AuxiliaryAuthorizer.ts:42</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L42">src/authorization/AuxiliaryAuthorizer.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -243,9 +250,15 @@
<aside class="tsd-sources">
<p>Overrides <a href="authorization_authorizer.authorizer.html">Authorizer</a>.<a href="authorization_authorizer.authorizer.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L30">src/authorization/AuxiliaryAuthorizer.ts:30</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L30">src/authorization/AuxiliaryAuthorizer.ts:30</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="authorization_auxiliaryauthorizer.auxiliaryauthorizer.html#canhandle">canHandle</a> function returned <code>true</code>.
Therefore, consider using the <a href="authorization_auxiliaryauthorizer.auxiliaryauthorizer.html#handlesafe">handleSafe</a> function instead.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -253,6 +266,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/authorization_authorization.authorization.html" class="tsd-signature-type" data-tsd-kind="Interface">Authorization</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A promise resolving when the handling is finished. Return value depends on the given type.</p>
</li>
</ul>
</section>
@@ -267,9 +281,16 @@
<aside class="tsd-sources">
<p>Overrides <a href="authorization_authorizer.authorizer.html">Authorizer</a>.<a href="authorization_authorizer.authorizer.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/authorization/AuxiliaryAuthorizer.ts#L36">src/authorization/AuxiliaryAuthorizer.ts:36</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/authorization/AuxiliaryAuthorizer.ts#L36">src/authorization/AuxiliaryAuthorizer.ts:36</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="authorization_auxiliaryauthorizer.auxiliaryauthorizer.html#canhandle">canHandle</a> function if the data can&#39;t be handled,
or returns the result of the <a href="authorization_auxiliaryauthorizer.auxiliaryauthorizer.html#handle">handle</a> function otherwise.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -277,6 +298,8 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/authorization_authorization.authorization.html" class="tsd-signature-type" data-tsd-kind="Interface">Authorization</a><span class="tsd-signature-symbol">&gt;</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>
@@ -286,7 +309,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="../modules/authorization_auxiliaryauthorizer.html">authorization/<wbr>Auxiliary<wbr>Authorizer</a>