mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
51 lines
29 KiB
HTML
51 lines
29 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>BasicRepresentation | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v2.0.0</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 - v2.0.0</a></li><li><a href="BasicRepresentation.html">BasicRepresentation</a></li></ul><h1>Class BasicRepresentation</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>Class with various constructors to facilitate creating a representation.</p>
|
|
</div><div><p>A representation consists of 1) data, 2) metadata, and 3) a binary flag
|
|
to indicate whether the data is a binary stream or an object stream.</p>
|
|
<ol>
|
|
<li>The data can be given as a stream, array, or string.</li>
|
|
<li>The metadata can be specified as one or two parameters
|
|
that will be passed to the <a href="RepresentationMetadata.html">RepresentationMetadata</a> constructor.</li>
|
|
<li>The binary field is optional, and if not specified,
|
|
is determined from the content type inside the metadata.</li>
|
|
</ol>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BasicRepresentation</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="BasicRepresentation.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#metadata" class="tsd-kind-icon">metadata</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="BasicRepresentation.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</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"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></li><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span>, metadata<span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a>, binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></li><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span>, metadata<span class="tsd-signature-symbol">: </span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a>, contentType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></li><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span>, contentType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></li><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span>, identifier<span class="tsd-signature-symbol">: </span><a href="../modules.html#MetadataIdentifier" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataIdentifier</a>, metadata<span class="tsd-signature-symbol">?: </span><a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a>, binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></li><li class="tsd-signature tsd-kind-icon">new <wbr/>Basic<wbr/>Representation<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span>, identifier<span class="tsd-signature-symbol">: </span><a href="../modules.html#MetadataIdentifier" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataIdentifier</a>, contentType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></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/216788e/src/http/representation/BasicRepresentation.ts#L30">src/http/representation/BasicRepresentation.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L37">src/http/representation/BasicRepresentation.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>The representation data</p>
|
|
</div></div></li><li><h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a></h5><div class="tsd-comment tsd-typography"><div><p>The representation metadata</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> binary: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Whether the representation is a binary or object stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L49">src/http/representation/BasicRepresentation.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>The representation data</p>
|
|
</div></div></li><li><h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a></h5><div class="tsd-comment tsd-typography"><div><p>The representation metadata</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contentType: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>The representation's content type</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> binary: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Whether the representation is a binary or object stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L61">src/http/representation/BasicRepresentation.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>The representation data</p>
|
|
</div></div></li><li><h5>contentType: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>The representation's content type</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> binary: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Whether the representation is a binary or object stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L73">src/http/representation/BasicRepresentation.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>The representation data</p>
|
|
</div></div></li><li><h5>identifier: <a href="../modules.html#MetadataIdentifier" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataIdentifier</a></h5><div class="tsd-comment tsd-typography"><div><p>The representation's identifier</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../modules.html#MetadataRecord" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataRecord</a></h5><div class="tsd-comment tsd-typography"><div><p>The representation metadata</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> binary: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Whether the representation is a binary or object stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L86">src/http/representation/BasicRepresentation.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An empty Representation</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">string</span><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">Readable</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>The representation data</p>
|
|
</div></div></li><li><h5>identifier: <a href="../modules.html#MetadataIdentifier" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataIdentifier</a></h5><div class="tsd-comment tsd-typography"><div><p>The representation's identifier</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contentType: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>The representation's content type</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> binary: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div><p>Whether the representation is a binary or object stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="BasicRepresentation.html" class="tsd-signature-type" data-tsd-kind="Class">BasicRepresentation</a></h4></li></ul></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-class"><a name="binary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> binary</h3><div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/Representation.html">Representation</a>.<a href="../interfaces/Representation.html#binary">binary</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L25">src/http/representation/BasicRepresentation.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether the data stream consists of binary/string chunks
|
|
(as opposed to complex objects).</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Readable</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/Representation.html">Representation</a>.<a href="../interfaces/Representation.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L23">src/http/representation/BasicRepresentation.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The raw data stream for this representation.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="metadata" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> metadata</h3><div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/Representation.html">Representation</a>.<a href="../interfaces/Representation.html#metadata">metadata</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L24">src/http/representation/BasicRepresentation.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The corresponding metadata.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a name="isEmpty" class="tsd-anchor"></a><h3>is<wbr/>Empty</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isEmpty<span class="tsd-signature-symbol">(</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"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/Representation.html">Representation</a>.<a href="../interfaces/Representation.html#isEmpty">isEmpty</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/http/representation/BasicRepresentation.ts#L124">src/http/representation/BasicRepresentation.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Data should only be interpreted if there is a content type.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="BasicRepresentation.html" class="tsd-kind-icon">Basic<wbr/>Representation</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="BasicRepresentation.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BasicRepresentation.html#metadata" class="tsd-kind-icon">metadata</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="BasicRepresentation.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</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-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">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><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</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><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |