Deploying to gh-pages from @ d250037 🚀

omar-azmi · Oct 18, 2023 · fc1aa9d · fc1aa9d
1 parent 3aa3d56
commit fc1aa9d
Show file tree

Hide file tree

Showing 68 changed files with 3,660 additions and 448 deletions.
diff --git a/assets/custom.css b/assets/custom.css
@@ -0,0 +1,4 @@
+
+table { border-collapse: collapse; }
+th { background-color: rgba(128, 128, 128, 0.50); }
+th, td { border: 0.1em solid rgba(0, 0, 0, 0.75); padding: 0.1em; }
diff --git a/assets/highlight.css b/assets/highlight.css
@@ -17,6 +17,8 @@
     --dark-hl-7: #C586C0;
     --light-hl-8: #A31515;
     --dark-hl-8: #CE9178;
+    --light-hl-9: #267F99;
+    --dark-hl-9: #4EC9B0;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -31,6 +33,7 @@
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 } }
 
@@ -44,6 +47,7 @@
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 } }
 
@@ -57,6 +61,7 @@
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 }
 
@@ -70,6 +75,7 @@
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 }
 
@@ -82,4 +88,5 @@
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
 .hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
 pre, code { background: var(--code-background); }
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/async_signal.Generated_Signal_Classes.AsyncStateSignal.html b/classes/async_signal.Generated_Signal_Classes.AsyncStateSignal.html
diff --git a/classes/context.Context.html b/classes/context.Context.html
diff --git a/classes/record_signal.Generated_Signal_Classes.MemoRecordSignal.html b/classes/record_signal.Generated_Signal_Classes.MemoRecordSignal.html
diff --git a/classes/record_signal.Generated_Signal_Classes.RecordSignal.html b/classes/record_signal.Generated_Signal_Classes.RecordSignal.html
diff --git a/classes/record_signal.Generated_Signal_Classes.RecordStateSignal.html b/classes/record_signal.Generated_Signal_Classes.RecordStateSignal.html
diff --git a/classes/signal.Generated_Signal_Classes.EffectSignal.html b/classes/signal.Generated_Signal_Classes.EffectSignal.html
diff --git a/classes/signal.Generated_Signal_Classes.LazySignal.html b/classes/signal.Generated_Signal_Classes.LazySignal.html
diff --git a/classes/signal.Generated_Signal_Classes.MemoSignal.html b/classes/signal.Generated_Signal_Classes.MemoSignal.html
diff --git a/classes/signal.Generated_Signal_Classes.SimpleSignal.html b/classes/signal.Generated_Signal_Classes.SimpleSignal.html
diff --git a/classes/signal.Generated_Signal_Classes.StateSignal.html b/classes/signal.Generated_Signal_Classes.StateSignal.html
diff --git a/enums/typedefs.SignalUpdateStatus.html b/enums/typedefs.SignalUpdateStatus.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>SignalUpdateStatus | tsignal_ts - v0.1.1</title><meta name="description" content="Documentation for tsignal_ts"/><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></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>SignalUpdateStatus | tsignal_ts - v0.1.2-c</title><meta name="description" content="Documentation for tsignal_ts"/><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/search.js" id="tsd-search-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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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">tsignal_ts - v0.1.1</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">tsignal_ts - v0.1.2-c</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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
@@ -15,9 +15,47 @@
 <li><a href="../index.html">tsignal_ts</a></li>
 <li><a href="../modules/typedefs.html">typedefs</a></li>
 <li><a href="typedefs.SignalUpdateStatus.html">SignalUpdateStatus</a></li></ul>
-<h1>Enumeration SignalUpdateStatus<code class="tsd-tag ts-flagConst">Const</code> </h1></div><aside class="tsd-sources">
+<h1>Enumeration SignalUpdateStatus<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>the numbers used for relaying the status of a signal after it has been <em>ran</em> via its <a href="../interfaces/typedefs.Signal.html#run" class="tsd-kind-method">run</a> method. <br>
+these numbers convey the following instructions to the context&#39;s topological update cycle context!Context.propagateSignalUpdate:</p>
 <ul>
-<li>Defined in typedefs.ts:54</li></ul></aside>
+<li><code> 1</code>: this signal&#39;s value has been updated, and therefore its observers should be updated too.</li>
+<li><code> 0</code>: this signal&#39;s value has not changed, and therefore its observers should be <em>not</em> be updated.
+do note that an observer signal will still run if some <em>other</em> of its dependency signal did updat this cycle (i.e. had a status value of <code>1</code>)</li>
+<li><code>-1</code>: this signal has been aborted, and therefore its observers must abort execution as well.
+the observers will abort <em>even</em> if they had a dependency that <em>did</em> update (had a status value of <code>1</code>)</li>
+</ul>
+<p>to sum up, given a signal <code>D</code>, with dependencies: <code>A</code>, <code>B</code>, and <code>C</code> (all of which are mutually independent of each other).
+then the status of <code>D</code> will be as follows in the order of highest conditional priority to lowest:</p>
+<table>
+<thead>
+<tr>
+<th>status of D</th>
+<th align="center">status of D as enum</th>
+<th align="center">condition</th>
+</tr>
+</thead>
+<tbody><tr>
+<td><code>status(D) = -1</code></td>
+<td align="center"><code>ABORTED</code></td>
+<td align="center"><code>∃X ∈ [A, B, C] such that status(X) === -1</code></td>
+</tr>
+<tr>
+<td><code>status(D) = D.run()</code></td>
+<td align="center"><code>CHANGED</code> or <code>UNCHANGED</code> or <code>ABORTED</code></td>
+<td align="center"><code>∃X ∈ [A, B, C] such that status(X) ===  1</code></td>
+</tr>
+<tr>
+<td><code>status(D) = 0</code></td>
+<td align="center"><code>UNCHANGED</code></td>
+<td align="center"><code>∀X ∈ [A, B, C], status(X) === 0</code></td>
+</tr>
+</tbody></table>
+</div>
+<div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources">
+<ul>
+<li>Defined in src/typedefs.ts:176</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,17 +73,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>ABORTED</span><a href="#ABORTED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">ABORTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-1</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in typedefs.ts:55</li></ul></aside></section>
+<li>Defined in src/typedefs.ts:177</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="UNCHANGED" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>UNCHANGED</span><a href="#UNCHANGED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">UNCHANGED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in typedefs.ts:56</li></ul></aside></section>
+<li>Defined in src/typedefs.ts:178</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="UPDATED" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>UPDATED</span><a href="#UPDATED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">UPDATED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in typedefs.ts:57</li></ul></aside></section></section></div>
+<li>Defined in src/typedefs.ts:179</li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -70,12 +108,13 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="#UPDATED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>UPDATED</span></a></li></ul></div></details></div>
 <div class="site-menu">
 <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/omar-azmi/tsignal_ts" target="_blank">github</a><a href="/tsignal_ts/" target="_blank">readme</a></nav>
-<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>tsignal_<wbr/>ts -<wbr/> v0.1.1</span></a>
+<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>tsignal_<wbr/>ts -<wbr/> v0.1.2-<wbr/>c</span></a>
 <ul class="tsd-small-nested-navigation">
+<li><a href="../modules/async_signal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>async_<wbr/>signal</span></a></li>
 <li><a href="../modules/context.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>context</span></a></li>
 <li><a href="../modules/funcdefs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>funcdefs</span></a></li>
-<li><a href="../modules/mapped_signal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>mapped_<wbr/>signal</span></a></li>
 <li><a href="../modules/mod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>mod</span></a></li>
+<li><a href="../modules/record_signal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>record_<wbr/>signal</span></a></li>
 <li><a href="../modules/signal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>signal</span></a></li>
 <li>
 <details class="tsd-index-accordion" open data-key="typedefs"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/typedefs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>typedefs</span></a></summary>
@@ -91,6 +130,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../types/typedefs.Updater.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Updater</span></a></li>
 <li><a href="../types/typedefs.Accessor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Accessor</span></a></li>
 <li><a href="../types/typedefs.Setter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Setter</span></a></li>
+<li><a href="../types/typedefs.AsyncSetter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Async<wbr/>Setter</span></a></li>
 <li><a href="../types/typedefs.Runner.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Runner</span></a></li>
 <li><a href="../interfaces/typedefs.Signal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Signal</span></a></li>
 <li><a href="../interfaces/typedefs.SignalClass.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Signal<wbr/>Class</span></a></li>