CommunitySolidServer/docs/classes/index.basicresponsewriter.html
2021-01-01 19:35:50 +00:00

361 lines
23 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BasicResponseWriter | 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">
<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</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</a>
</li>
<li>
<a href="../modules/index.html">index</a>
</li>
<li>
<a href="index.basicresponsewriter.html">BasicResponseWriter</a>
</li>
</ul>
<h1>Class BasicResponseWriter</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>Writes to an <a href="../modules/index.html#httpresponse">HttpResponse</a> based on the incoming <a href="index.responsedescription.html">ResponseDescription</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ldp_http_responsewriter.responsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseWriter</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">BasicResponseWriter</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-inherited"><a href="index.basicresponsewriter.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-protected"><a href="index.basicresponsewriter.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="index.basicresponsewriter.html#metadatawriter" class="tsd-kind-icon">metadata<wbr>Writer</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-overwrite"><a href="index.basicresponsewriter.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="index.basicresponsewriter.html#handle" class="tsd-kind-icon">handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="index.basicresponsewriter.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-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Basic<wbr>Response<wbr>Writer<span class="tsd-signature-symbol">(</span>metadataWriter<span class="tsd-signature-symbol">: </span><a href="ldp_http_metadata_metadatawriter.metadatawriter.html" class="tsd-signature-type" data-tsd-kind="Class">MetadataWriter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ldp_http_basicresponsewriter.basicresponsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">BasicResponseWriter</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ldp_http_responsewriter.responsewriter.html">ResponseWriter</a>.<a href="ldp_http_responsewriter.responsewriter.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/dc62c84/src/ldp/http/BasicResponseWriter.ts#L15">src/ldp/http/BasicResponseWriter.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadataWriter: <a href="ldp_http_metadata_metadatawriter.metadatawriter.html" class="tsd-signature-type" data-tsd-kind="Class">MetadataWriter</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ldp_http_basicresponsewriter.basicresponsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">BasicResponseWriter</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-protected">
<a name="logger" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
<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/dc62c84/src/ldp/http/BasicResponseWriter.ts#L14">src/ldp/http/BasicResponseWriter.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="metadatawriter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> metadata<wbr>Writer</h3>
<div class="tsd-signature tsd-kind-icon">metadata<wbr>Writer<span class="tsd-signature-symbol">:</span> <a href="ldp_http_metadata_metadatawriter.metadatawriter.html" class="tsd-signature-type" data-tsd-kind="Class">MetadataWriter</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/dc62c84/src/ldp/http/BasicResponseWriter.ts#L15">src/ldp/http/BasicResponseWriter.ts:15</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-overwrite">
<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-overwrite">
<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-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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-symbol">: </span><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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="ldp_http_responsewriter.responsewriter.html">ResponseWriter</a>.<a href="ldp_http_responsewriter.responsewriter.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/dc62c84/src/ldp/http/BasicResponseWriter.ts#L22">src/ldp/http/BasicResponseWriter.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a></h5>
</li>
<li class="tsd-parameter">
<h5>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
</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>
</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>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="ldp_http_responsewriter.responsewriter.html">ResponseWriter</a>.<a href="ldp_http_responsewriter.responsewriter.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/dc62c84/src/ldp/http/BasicResponseWriter.ts#L28">src/ldp/http/BasicResponseWriter.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a></h5>
</li>
<li class="tsd-parameter">
<h5>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a></h5>
</li>
</ul>
</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>
</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>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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-symbol">: </span><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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ldp_http_responsewriter.responsewriter.html">ResponseWriter</a>.<a href="ldp_http_responsewriter.responsewriter.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/dc62c84/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="index.basicresponsewriter.html#canhandle">canHandle</a> function if the data can&#39;t be handled,
or returns the result of the <a href="index.basicresponsewriter.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-symbol">{ </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data to handle.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a></h5>
</li>
<li class="tsd-parameter">
<h5>result<span class="tsd-signature-symbol">: </span><a href="ldp_http_response_responsedescription.responsedescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
</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>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=" ">
<a href="../modules.html">Exports</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/index.html">index</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="index.basicresponsewriter.html" class="tsd-kind-icon">Basic<wbr>Response<wbr>Writer</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="index.basicresponsewriter.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="index.basicresponsewriter.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="index.basicresponsewriter.html#metadatawriter" class="tsd-kind-icon">metadata<wbr>Writer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="index.basicresponsewriter.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="index.basicresponsewriter.html#handle" class="tsd-kind-icon">handle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="index.basicresponsewriter.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-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>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-protected"><span class="tsd-kind-icon">Protected property</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>