Docs

ClintH · Jul 28, 2024 · e773f6f · e773f6f
1 parent cd4f6fa
commit e773f6f
Show file tree

Hide file tree

Showing 81 changed files with 620 additions and 180 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -23,14 +23,14 @@
     --dark-hl-10: #C8C8C8;
     --light-hl-11: #267F99;
     --dark-hl-11: #4EC9B0;
-    --light-hl-12: #CD3131;
-    --dark-hl-12: #F44747;
-    --light-hl-13: #E50000;
-    --dark-hl-13: #9CDCFE;
-    --light-hl-14: #0451A5;
-    --dark-hl-14: #CE9178;
-    --light-hl-15: #800000;
-    --dark-hl-15: #569CD6;
+    --light-hl-12: #E50000;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #0451A5;
+    --dark-hl-13: #CE9178;
+    --light-hl-14: #800000;
+    --dark-hl-14: #569CD6;
+    --light-hl-15: #CD3131;
+    --dark-hl-15: #F44747;
     --light-hl-16: #EE0000;
     --dark-hl-16: #D7BA7D;
     --light-code-background: #FFFFFF;

diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Collections.ExpiringMap.html b/docs/classes/Collections.ExpiringMap.html
diff --git a/docs/classes/Collections.MapOfSimpleMutable.html b/docs/classes/Collections.MapOfSimpleMutable.html
diff --git a/docs/classes/Collections.QueueImmutable.html b/docs/classes/Collections.QueueImmutable.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueueImmutable | ixfx</title><meta name="description" content="Documentation for ixfx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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">ixfx</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="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ixfx</a></li><li><a href="../modules/Collections.html">Collections</a></li><li><a href="Collections.QueueImmutable.html">QueueImmutable</a></li></ul><h1>Class QueueImmutable&lt;V&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Queue (immutable). See also <a href="Collections.Queues.QueueMutable.html" class="tsd-kind-class">QueueMutable</a>.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueueImmutable | ixfx</title><meta name="description" content="Documentation for ixfx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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">ixfx</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="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ixfx</a></li><li><a href="../modules/Collections.html">Collections</a></li><li><a href="Collections.QueueImmutable.html">QueueImmutable</a></li></ul><h1>Class QueueImmutable&lt;V&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Queue (immutable). See also <a href="Collections.QueueMutable.html" class="tsd-kind-class">QueueMutable</a>.</p>
 <p>Queues are useful if you want to treat 'older' or 'newer'
 items differently. <em>Enqueing</em> adds items at the back of the queue, while
 <em>dequeing</em> removes items from the front (ie. the oldest).</p>

diff --git a/docs/classes/Collections.QueueMutable.html b/docs/classes/Collections.QueueMutable.html
diff --git a/docs/classes/Collections.Queues.PriorityMutable.html b/docs/classes/Collections.Queues.PriorityMutable.html
diff --git a/docs/classes/Collections.SetStringMutable.html b/docs/classes/Collections.SetStringMutable.html
diff --git a/docs/classes/Collections.StackImmutable.html b/docs/classes/Collections.StackImmutable.html
@@ -7,7 +7,8 @@ <h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a hre
 
 <p>Stack can also be created from the basis of an existing array. First index of array will be the bottom of the stack.
 Stack</p>
-</div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="V" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">V</span></span><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/Collections.Stacks.IStackImmutable.html" class="tsd-signature-type tsd-kind-interface">IStackImmutable</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Collections.StackImmutable.html#constructor.new_StackImmutable.V-1">V</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Collections.StackImmutable.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="V" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">V</span></span><div class="tsd-comment tsd-typography"><p>Type of stored items</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/Collections.Stacks.IStackImmutable.html" class="tsd-signature-type tsd-kind-interface">IStackImmutable</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Collections.StackImmutable.html#constructor.new_StackImmutable.V-1">V</a><span class="tsd-signature-symbol">&gt;</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Collections.StackImmutable.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Collections.StackImmutable.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="Collections.StackImmutable.html#isEmpty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Empty</span></a>
 <a href="Collections.StackImmutable.html#isFull" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Full</span></a>