mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
344 lines
16 KiB
HTML
344 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>AsyncHandler | 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_asynchandler_.html">"util/AsyncHandler"</a>
|
|
</li>
|
|
<li>
|
|
<a href="_util_asynchandler_.asynchandler.html">AsyncHandler</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class AsyncHandler<TIn, TOut></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>Simple interface for classes that can potentially handle a specific kind of data asynchronously.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-type-parameters">
|
|
<h3>Type parameters</h3>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>TIn = <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
<li>
|
|
<h4>TOut = <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">AsyncHandler</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="_authentication_credentialsextractor_.credentialsextractor.html" class="tsd-signature-type">CredentialsExtractor</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_targetextractor_.targetextractor.html" class="tsd-signature-type">TargetExtractor</a>
|
|
</li>
|
|
<li>
|
|
<a href="_authorization_authorizer_.authorizer.html" class="tsd-signature-type">Authorizer</a>
|
|
</li>
|
|
<li>
|
|
<a href="_init_initializer_.initializer.html" class="tsd-signature-type">Initializer</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_metadata_metadataextractor_.metadataextractor.html" class="tsd-signature-type">MetadataExtractor</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_metadata_metadatawriter_.metadatawriter.html" class="tsd-signature-type">MetadataWriter</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_preferenceparser_.preferenceparser.html" class="tsd-signature-type">PreferenceParser</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_bodyparser_.bodyparser.html" class="tsd-signature-type">BodyParser</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_requestparser_.requestparser.html" class="tsd-signature-type">RequestParser</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_http_responsewriter_.responsewriter.html" class="tsd-signature-type">ResponseWriter</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_operations_operationhandler_.operationhandler.html" class="tsd-signature-type">OperationHandler</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_permissions_permissionsextractor_.permissionsextractor.html" class="tsd-signature-type">PermissionsExtractor</a>
|
|
</li>
|
|
<li>
|
|
<a href="_server_httphandler_.httphandler.html" class="tsd-signature-type">HttpHandler</a>
|
|
</li>
|
|
<li>
|
|
<a href="_server_websockethandler_.websockethandler.html" class="tsd-signature-type">WebSocketHandler</a>
|
|
</li>
|
|
<li>
|
|
<a href="_pods_agent_agentparser_.agentparser.html" class="tsd-signature-type">AgentParser</a>
|
|
</li>
|
|
<li>
|
|
<a href="_storage_conversion_representationconverter_.representationconverter.html" class="tsd-signature-type">RepresentationConverter</a>
|
|
</li>
|
|
<li>
|
|
<a href="_storage_patch_patchhandler_.patchhandler.html" class="tsd-signature-type">PatchHandler</a>
|
|
</li>
|
|
<li>
|
|
<a href="_storage_routing_routerrule_.routerrule.html" class="tsd-signature-type">RouterRule</a>
|
|
</li>
|
|
<li>
|
|
<a href="_util_sequencehandler_.sequencehandler.html" class="tsd-signature-type">SequenceHandler</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implemented by</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="_util_waterfallhandler_.waterfallhandler.html" class="tsd-signature-type">WaterfallHandler</a></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>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_util_asynchandler_.asynchandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_util_asynchandler_.asynchandler.html#handle" class="tsd-kind-icon">handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_util_asynchandler_.asynchandler.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>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="canhandle" class="tsd-anchor"></a>
|
|
<h3>can<wbr>Handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TIn</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><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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/53479eb/src/util/AsyncHandler.ts#L13">src/util/AsyncHandler.ts:13</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't handle the data.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">TIn</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Input data that would be handled potentially.</p>
|
|
</div>
|
|
</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>
|
|
<p>A promise resolving if this input can be handled, rejecting with an Error if not.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="handle" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TIn</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><span class="tsd-signature-type">TOut</span><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/53479eb/src/util/AsyncHandler.ts#L23">src/util/AsyncHandler.ts:23</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="_util_asynchandler_.asynchandler.html#canhandle">canHandle</a> function returned <code>true</code>.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <span class="tsd-signature-type">TIn</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Input data that needs to 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><span class="tsd-signature-type">TOut</span><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">
|
|
<a name="handlesafe" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Safe</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TIn</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><span class="tsd-signature-type">TOut</span><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/53479eb/src/util/AsyncHandler.ts#L33">src/util/AsyncHandler.ts:33</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="_util_asynchandler_.asynchandler.html#canhandle">canHandle</a> function if the data can't be handled,
|
|
or returns the result of the <a href="_util_asynchandler_.asynchandler.html#handle">handle</a> function otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">TIn</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The data to handle.</p>
|
|
</div>
|
|
</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">TOut</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The result of the handle function of the handler.</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="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/_util_asynchandler_.html">"util/<wbr>Async<wbr>Handler"</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 tsd-has-type-parameter">
|
|
<a href="_util_asynchandler_.asynchandler.html" class="tsd-kind-icon">Async<wbr>Handler</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_util_asynchandler_.asynchandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_util_asynchandler_.asynchandler.html#handle" class="tsd-kind-icon">handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="_util_asynchandler_.asynchandler.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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-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-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>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |