Deploying to gh-pages from @ c88ec0a 🚀

ObjectManager.html

@@ -17,7 +17,7 @@
 // Upload Directory
 await objectManager.upload("my-first-directory", [
  {
-  path: "/testObjects/1.txt",
+  path: "/testObjects/1.txt",  // Virtual Path to store contents at within IPFS Folder/Directory
   content: Buffer.from("upload test object", "utf-8"),
  },
  {
@@ -28,12 +28,12 @@
   path: "/topLevel.txt",
   content: Buffer.from("upload top level test object", "utf-8"),
  },
-]);</code></pre></div></div><h3 class="name has-anchor" id="get"><span class="type-signature">(async) </span>get<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="global.html#objectHeadResult">objectHeadResult</a>|false)>}</span></h3><div class="summary"><p>Gets an objects info and metadata using the S3 API.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be inspected.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for inspecting the object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line422">line 422</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;(<a href="global.html#objectHeadResult">objectHeadResult</a>|false)></span></dd></dl></div><h3 class="name has-anchor" id="download"><span class="type-signature">(async) </span>download<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h3><div class="summary"><p>Downloads an object from the specified bucket using the provided key.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be downloaded.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for downloading the object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line453">line 453</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves with the contents of the downloaded object as a Stream.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Object></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Download object with name of `download-object-example`
-await objectManager.download(`download-object-example`);</code></pre></div></div><h3 class="name has-anchor" id="list"><span class="type-signature">(async) </span>list<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#listObjectsResult">listObjectsResult</a>>}</span></h3><div class="summary">Retrieves a list of objects from a specified bucket.</div><div class="description"><p>Retrieves a list of objects from a specified bucket.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#listObjectOptions">listObjectOptions</a></span></td><td class="description last"><p>The options for listing objects.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line502">line 502</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of objects.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;<a href="global.html#listObjectsResult">listObjectsResult</a>></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// List objects in bucket with a limit of 1000
+]);</code></pre></div></div><h3 class="name has-anchor" id="get"><span class="type-signature">(async) </span>get<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="global.html#objectHeadResult">objectHeadResult</a>|false)>}</span></h3><div class="summary"><p>Gets an objects info and metadata using the S3 API.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be inspected.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for inspecting the object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line423">line 423</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;(<a href="global.html#objectHeadResult">objectHeadResult</a>|false)></span></dd></dl></div><h3 class="name has-anchor" id="download"><span class="type-signature">(async) </span>download<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h3><div class="summary"><p>Downloads an object from the specified bucket using the provided key.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be downloaded.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for downloading the object.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line454">line 454</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves with the contents of the downloaded object as a Stream.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Object></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Download object with name of `download-object-example`
+await objectManager.download(`download-object-example`);</code></pre></div></div><h3 class="name has-anchor" id="list"><span class="type-signature">(async) </span>list<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#listObjectsResult">listObjectsResult</a>>}</span></h3><div class="summary">Retrieves a list of objects from a specified bucket.</div><div class="description"><p>Retrieves a list of objects from a specified bucket.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#listObjectOptions">listObjectOptions</a></span></td><td class="description last"><p>The options for listing objects.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line503">line 503</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A promise that resolves to an array of objects.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;<a href="global.html#listObjectsResult">listObjectsResult</a>></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// List objects in bucket with a limit of 1000
 await objectManager.list({
   MaxKeys: 1000
-});</code></pre></div></div><h3 class="name has-anchor" id="delete"><span class="type-signature">(async) </span>delete<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h3><div class="summary"><p>Deletes an object from the specified bucket using the provided key.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be deleted.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for deleting the file.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line538">line 538</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A Promise that resolves with the result of the delete operation.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Boolean></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Delete object with name of `delete-object-example`
-await objectManager.delete(`delete-object-example`);</code></pre></div></div><h3 class="name has-anchor" id="copy"><span class="type-signature">(async) </span>copy<span class="signature">(sourceKey, destinationBucket, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h3><div class="summary"><p>Copy the object from sourceKey in the sourceBucket to destinationKey in the destinationBucket.</p></div><div class="description"><p>If the destinationKey is not provided, the object will be copied with the same key as the sourceKey.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>sourceKey</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be copied from the sourceBucket.</p></td></tr><tr><td class="name"><code>destinationBucket</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The bucket where the object will be copied to.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#copyObjectOptions">copyObjectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Additional options for the copy operation.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line570">line 570</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A Promise that resolves with the result of the copy operation.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Boolean></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Copy object `copy-object-test` from `copy-object-test-pass-src` to `copy-object-test-pass-dest`
+});</code></pre></div></div><h3 class="name has-anchor" id="delete"><span class="type-signature">(async) </span>delete<span class="signature">(key, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h3><div class="summary"><p>Deletes an object from the specified bucket using the provided key.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>key</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be deleted.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#objectOptions">objectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>The options for deleting the file.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line539">line 539</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A Promise that resolves with the result of the delete operation.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Boolean></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Delete object with name of `delete-object-example`
+await objectManager.delete(`delete-object-example`);</code></pre></div></div><h3 class="name has-anchor" id="copy"><span class="type-signature">(async) </span>copy<span class="signature">(sourceKey, destinationBucket, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h3><div class="summary"><p>Copy the object from sourceKey in the sourceBucket to destinationKey in the destinationBucket.</p></div><div class="description"><p>If the destinationKey is not provided, the object will be copied with the same key as the sourceKey.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>sourceKey</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The key of the object to be copied from the sourceBucket.</p></td></tr><tr><td class="name"><code>destinationBucket</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="description last"><p>The bucket where the object will be copied to.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="global.html#copyObjectOptions">copyObjectOptions</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>Additional options for the copy operation.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="objectManager.js.html">objectManager.js</a>, <a href="objectManager.js.html#line571">line 571</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>A Promise that resolves with the result of the copy operation.</li></ul></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Promise.&lt;Boolean></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Copy object `copy-object-test` from `copy-object-test-pass-src` to `copy-object-test-pass-dest`
 // TIP: Set bucket on constructor, it will be used as the default source for copying objects.
 await objectManager.copy(`copy-object-test`, `copy-object-dest`, {
   sourceBucket: `copy-object-src`