Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/docs/interfaces/index.conditions.html
RubenVerborgh edf56b2d8b deploy: da5515d50df8e85099ac6bfe53e553a20ed35f26
2021-01-02 15:29:34 +00:00

327 lines
15 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Conditions | 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.conditions.html">Conditions</a>
</li>
</ul>
<h1>Interface Conditions</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>The conditions of an HTTP conditional request.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Conditions</span>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#matches" class="tsd-kind-icon">matches</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#matchesetag" class="tsd-kind-icon">matches<wbr>Etag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#matchesmetadata" class="tsd-kind-icon">matches<wbr>Metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#modifiedsince" class="tsd-kind-icon">modified<wbr>Since</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#notmatchesetag" class="tsd-kind-icon">not<wbr>Matches<wbr>Etag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.conditions.html#unmodifiedsince" class="tsd-kind-icon">unmodified<wbr>Since</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="matches" class="tsd-anchor"></a>
<h3>matches</h3>
<div class="tsd-signature tsd-kind-icon">matches<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>eTag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, lastModified<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/da5515d/src/storage/Conditions.ts#L34">src/storage/Conditions.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks validity based on the given ETag and/org date.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Condition based on ETag.</p>
</dd>
<dt>param</dt>
<dd><p>Condition based on last modified date.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eTag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, lastModified<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> eTag: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> lastModified: <span class="tsd-signature-type">Date</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="matchesetag" class="tsd-anchor"></a>
<h3>matches<wbr>Etag</h3>
<div class="tsd-signature tsd-kind-icon">matches<wbr>Etag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/da5515d/src/storage/Conditions.ts#L10">src/storage/Conditions.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Valid if matching any of the given ETags.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="matchesmetadata" class="tsd-anchor"></a>
<h3>matches<wbr>Metadata</h3>
<div class="tsd-signature tsd-kind-icon">matches<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../classes/ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/da5515d/src/storage/Conditions.ts#L28">src/storage/Conditions.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks validity based on the given metadata.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Metadata of the representation.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../classes/ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadata: <a href="../classes/ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="modifiedsince" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> modified<wbr>Since</h3>
<div class="tsd-signature tsd-kind-icon">modified<wbr>Since<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/da5515d/src/storage/Conditions.ts#L18">src/storage/Conditions.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Valid if modified since the given date.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="notmatchesetag" class="tsd-anchor"></a>
<h3>not<wbr>Matches<wbr>Etag</h3>
<div class="tsd-signature tsd-kind-icon">not<wbr>Matches<wbr>Etag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/da5515d/src/storage/Conditions.ts#L14">src/storage/Conditions.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Valid if not matching any of the given ETags.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="unmodifiedsince" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> unmodified<wbr>Since</h3>
<div class="tsd-signature tsd-kind-icon">unmodified<wbr>Since<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/da5515d/src/storage/Conditions.ts#L22">src/storage/Conditions.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Valid if not modified since the given date.</p>
</div>
</div>
</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-interface tsd-parent-kind-module">
<a href="index.conditions.html" class="tsd-kind-icon">Conditions</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#matches" class="tsd-kind-icon">matches</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#matchesetag" class="tsd-kind-icon">matches<wbr>Etag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#matchesmetadata" class="tsd-kind-icon">matches<wbr>Metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#modifiedsince" class="tsd-kind-icon">modified<wbr>Since</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#notmatchesetag" class="tsd-kind-icon">not<wbr>Matches<wbr>Etag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.conditions.html#unmodifiedsince" class="tsd-kind-icon">unmodified<wbr>Since</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-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>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink