docs: update documentation [skip ci]

ipfs · Oct 13, 2023 · ea55cfc · ea55cfc
1 parent ac50a10
commit ea55cfc
Show file tree

Hide file tree

Showing 25 changed files with 95 additions and 95 deletions.
diff --git a/assets/highlight.css b/assets/highlight.css
@@ -17,16 +17,16 @@
     --dark-hl-7: #9CDCFE;
     --light-hl-8: #795E26;
     --dark-hl-8: #DCDCAA;
-    --light-hl-9: #AF00DB;
-    --dark-hl-9: #C586C0;
-    --light-hl-10: #0000FF;
-    --dark-hl-10: #569CD6;
-    --light-hl-11: #008000;
-    --dark-hl-11: #6A9955;
-    --light-hl-12: #267F99;
-    --dark-hl-12: #4EC9B0;
-    --light-hl-13: #001080;
-    --dark-hl-13: #9CDCFE;
+    --light-hl-9: #0000FF;
+    --dark-hl-9: #569CD6;
+    --light-hl-10: #008000;
+    --dark-hl-10: #6A9955;
+    --light-hl-11: #267F99;
+    --dark-hl-11: #4EC9B0;
+    --light-hl-12: #001080;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #AF00DB;
+    --dark-hl-13: #C586C0;
     --light-hl-14: #0070C1;
     --dark-hl-14: #4FC1FF;
     --light-hl-15: #098658;

diff --git a/classes/utils_echo_server.default.html b/classes/utils_echo_server.default.html
@@ -1,12 +1,12 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | aegir - v41.0.4</title><meta name="description" content="Documentation for aegir"/><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 defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | aegir - v41.0.5</title><meta name="description" content="Documentation for aegir"/><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 defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></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">aegir - v41.0.4</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">aegir - v41.0.5</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
@@ -20,7 +20,7 @@ <h1>Class default</h1></div>
 <div class="tsd-comment tsd-typography"><p>HTTP echo server for testing purposes.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Example</h4><pre><code class="language-js"><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">EchoServer</span><span class="hl-0"> = </span><span class="hl-8">require</span><span class="hl-0">(</span><span class="hl-6">&#39;aegir/utils/echo-server&#39;</span><span class="hl-0">)</span><br/><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">server</span><span class="hl-0"> = </span><span class="hl-10">new</span><span class="hl-0"> </span><span class="hl-8">EchoServer</span><span class="hl-0">()</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">server</span><span class="hl-0">.</span><span class="hl-8">start</span><span class="hl-0">()</span><br/><br/><span class="hl-11">// search params echo endpoint</span><br/><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/echo/query?test=one&#39;</span><span class="hl-0">)</span><br/><span class="hl-13">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-11">// body echo endpoint</span><br/><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/echo&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">  </span><span class="hl-13">method:</span><span class="hl-0"> </span><span class="hl-6">&#39;POST&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-13">body:</span><span class="hl-0"> </span><span class="hl-6">&#39;{&quot;key&quot;: &quot;value&quot;}&#39;</span><br/><span class="hl-0">})</span><br/><span class="hl-13">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-11">// redirect endpoint</span><br/><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/redirect?to=http://127.0.0.1:3000/echo&#39;</span><span class="hl-0">)</span><br/><span class="hl-13">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-11">// download endpoint</span><br/><span class="hl-10">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/download?data=helloWorld&#39;</span><span class="hl-0">)</span><br/><span class="hl-13">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-13">server</span><span class="hl-0">.</span><span class="hl-8">stop</span><span class="hl-0">()</span>
+<h4>Example</h4><pre><code class="language-js"><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">EchoServer</span><span class="hl-0"> = </span><span class="hl-8">require</span><span class="hl-0">(</span><span class="hl-6">&#39;aegir/utils/echo-server&#39;</span><span class="hl-0">)</span><br/><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">server</span><span class="hl-0"> = </span><span class="hl-9">new</span><span class="hl-0"> </span><span class="hl-8">EchoServer</span><span class="hl-0">()</span><br/><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">server</span><span class="hl-0">.</span><span class="hl-8">start</span><span class="hl-0">()</span><br/><br/><span class="hl-10">// search params echo endpoint</span><br/><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/echo/query?test=one&#39;</span><span class="hl-0">)</span><br/><span class="hl-12">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-10">// body echo endpoint</span><br/><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/echo&#39;</span><span class="hl-0">, {</span><br/><span class="hl-0">  </span><span class="hl-12">method:</span><span class="hl-0"> </span><span class="hl-6">&#39;POST&#39;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-12">body:</span><span class="hl-0"> </span><span class="hl-6">&#39;{&quot;key&quot;: &quot;value&quot;}&#39;</span><br/><span class="hl-0">})</span><br/><span class="hl-12">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-10">// redirect endpoint</span><br/><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/redirect?to=http://127.0.0.1:3000/echo&#39;</span><span class="hl-0">)</span><br/><span class="hl-12">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-10">// download endpoint</span><br/><span class="hl-9">const</span><span class="hl-0"> </span><span class="hl-14">req</span><span class="hl-0"> = </span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-8">fetch</span><span class="hl-0">(</span><span class="hl-6">&#39;http://127.0.0.1:3000/download?data=helloWorld&#39;</span><span class="hl-0">)</span><br/><span class="hl-12">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">req</span><span class="hl-0">.</span><span class="hl-8">text</span><span class="hl-0">())</span><br/><br/><span class="hl-13">await</span><span class="hl-0"> </span><span class="hl-12">server</span><span class="hl-0">.</span><span class="hl-8">stop</span><span class="hl-0">()</span>
 </code><button>Copy</button></pre>
 </div></section>
 <section class="tsd-panel tsd-hierarchy">
@@ -178,7 +178,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a></li>
 <li><a href="#stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>stop</span></a></li></ul></div></details></div>
 <div class="site-menu">
-<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>aegir - v41.0.4</span></a>
+<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>aegir - v41.0.5</span></a>
 <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
 <li><a href="../modules/src.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>src</a></li>
 <li><a href="../modules/src_env.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>src/env</a></li>

diff --git a/functions/utils_chai.assert.html b/functions/utils_chai.assert.html
@@ -1,12 +1,12 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>assert | aegir - v41.0.4</title><meta name="description" content="Documentation for aegir"/><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 defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>assert | aegir - v41.0.5</title><meta name="description" content="Documentation for aegir"/><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 defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></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">aegir - v41.0.4</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">aegir - v41.0.5</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
@@ -31,7 +31,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">asserts
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><p><a href="https://www.chaijs.com/api/assert/">Chai assert docs</a></p>
 
-<h4>Example</h4><pre><code class="language-js"><span class="hl-9">import</span><span class="hl-0"> { </span><span class="hl-13">assert</span><span class="hl-0"> } </span><span class="hl-9">from</span><span class="hl-0"> </span><span class="hl-6">&#39;aegir/chai&#39;</span><br/><br/><span class="hl-8">assert</span><span class="hl-0">(</span><span class="hl-10">true</span><span class="hl-0">)</span>
+<h4>Example</h4><pre><code class="language-js"><span class="hl-13">import</span><span class="hl-0"> { </span><span class="hl-12">assert</span><span class="hl-0"> } </span><span class="hl-13">from</span><span class="hl-0"> </span><span class="hl-6">&#39;aegir/chai&#39;</span><br/><br/><span class="hl-8">assert</span><span class="hl-0">(</span><span class="hl-9">true</span><span class="hl-0">)</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <ul>
@@ -52,7 +52,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
 <div class="tsd-theme-toggle">
 <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
 <div class="site-menu">
-<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>aegir - v41.0.4</span></a>
+<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>aegir - v41.0.5</span></a>
 <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
 <li><a href="../modules/src.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>src</a></li>
 <li><a href="../modules/src_env.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>src/env</a></li>