[Release] Increase version to 0.2.3 (#48)

nevware21 · Apr 25, 2023 · ff4141a · ff4141a
1 parent 478f997
commit ff4141a
Show file tree

Hide file tree

Showing 36 changed files with 313 additions and 293 deletions.
diff --git a/CHANGELIST.md b/CHANGELIST.md
@@ -1,3 +1,13 @@
+# v0.2.3 Apr 24th, 2023
+
+## Changelog
+
+- #47 Add alias for Promise to avoid matching "new Promise"
+- #46 Bump typedoc to ^0.24.4
+- #45 Update release packaging and publishing steps
+- #44 Bump @microsoft/rush from 5.97.0 to 5.97.1
+- #39 Bump @microsoft/rush from 5.95.0 to 5.97.0
+
 # v0.2.2 Mar 25th, 2023
 
 ## Changelog

diff --git a/docs/typedoc/assets/highlight.css b/docs/typedoc/assets/highlight.css
@@ -3,22 +3,22 @@
     --dark-hl-0: #569CD6;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #0070C1;
-    --dark-hl-2: #4FC1FF;
-    --light-hl-3: #795E26;
-    --dark-hl-3: #DCDCAA;
-    --light-hl-4: #001080;
-    --dark-hl-4: #9CDCFE;
-    --light-hl-5: #AF00DB;
-    --dark-hl-5: #C586C0;
-    --light-hl-6: #A31515;
-    --dark-hl-6: #CE9178;
-    --light-hl-7: #008000;
-    --dark-hl-7: #6A9955;
-    --light-hl-8: #098658;
-    --dark-hl-8: #B5CEA8;
-    --light-hl-9: #267F99;
-    --dark-hl-9: #4EC9B0;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #267F99;
+    --dark-hl-3: #4EC9B0;
+    --light-hl-4: #795E26;
+    --dark-hl-4: #DCDCAA;
+    --light-hl-5: #A31515;
+    --dark-hl-5: #CE9178;
+    --light-hl-6: #008000;
+    --dark-hl-6: #6A9955;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
+    --light-hl-8: #AF00DB;
+    --dark-hl-8: #C586C0;
+    --light-hl-9: #098658;
+    --dark-hl-9: #B5CEA8;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }

diff --git a/docs/typedoc/assets/main.js b/docs/typedoc/assets/main.js
diff --git a/docs/typedoc/assets/style.css b/docs/typedoc/assets/style.css
@@ -51,13 +51,13 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
-    --dark-color-ts-project: #e14dff;
+    --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
     --dark-color-ts-enum: #f4d93e;
     --dark-color-ts-enum-member: var(--dark-color-ts-enum);
     --dark-color-ts-variable: #798dff;
-    --dark-color-ts-function: #9772ff;
+    --dark-color-ts-function: #a280ff;
     --dark-color-ts-class: #8ac4ff;
     --dark-color-ts-interface: #6cff87;
     --dark-color-ts-constructor: var(--dark-color-ts-class);
@@ -262,6 +262,16 @@ h6 {
     line-height: 1.2;
 }
 
+h1 > a,
+h2 > a,
+h3 > a,
+h4 > a,
+h5 > a,
+h6 > a {
+    text-decoration: none;
+    color: var(--color-text);
+}
+
 h1 {
     font-size: 1.875rem;
     margin: 0.67rem 0;
@@ -296,12 +306,6 @@ h6 {
     text-transform: uppercase;
 }
 
-pre {
-    white-space: pre;
-    white-space: pre-wrap;
-    word-wrap: break-word;
-}
-
 dl,
 menu,
 ol,
@@ -426,13 +430,29 @@ pre {
 }
 
 pre {
+    position: relative;
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
     padding: 10px;
-    border: 0.1em solid var(--color-accent);
+    border: 1px solid var(--color-accent);
 }
 pre code {
     padding: 0;
     font-size: 100%;
 }
+pre > button {
+    position: absolute;
+    top: 10px;
+    right: 10px;
+    opacity: 0;
+    transition: opacity 0.1s;
+    box-sizing: border-box;
+}
+pre:hover > button,
+pre > button.visible {
+    opacity: 1;
+}
 
 blockquote {
     margin: 1em 0;
@@ -676,7 +696,12 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 .tsd-navigation.settings {
     margin: 1rem 0;
 }
+.tsd-navigation > a,
+.tsd-navigation .tsd-accordion-summary {
+    width: calc(100% - 0.5rem);
+}
 .tsd-navigation a,
+.tsd-navigation summary > span,
 .tsd-page-navigation a {
     display: inline-flex;
     align-items: center;
@@ -685,14 +710,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     text-decoration: none;
     box-sizing: border-box;
 }
-.tsd-navigation a {
-    /* why 3rem? No idea, but it seems to work. */
-    width: calc(100% - 3rem);
-}
-.tsd-page-navigation a {
-    /* why is this different? */
-    width: 100%;
-}
 .tsd-navigation a.current,
 .tsd-page-navigation a.current {
     background: var(--color-active-menu-item);
@@ -703,7 +720,8 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 }
 .tsd-navigation ul,
 .tsd-page-navigation ul {
-    margin: 0;
+    margin-top: 0;
+    margin-bottom: 0;
     padding: 0;
     list-style: none;
 }
@@ -712,18 +730,24 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     padding: 0;
     max-width: 100%;
 }
-.tsd-nested-navigation > li > a {
+.tsd-nested-navigation {
     margin-left: 3rem;
 }
 .tsd-nested-navigation > li > details {
-    margin-left: 1.5rem;
+    margin-left: -1.5rem;
 }
-.tsd-small-nested-navigation > li > a {
+.tsd-small-nested-navigation {
     margin-left: 1.5rem;
 }
 .tsd-small-nested-navigation > li > details {
-    margin-left: 0;
+    margin-left: -1.5rem;
+}
+
+.tsd-nested-navigation > li > a,
+.tsd-nested-navigation > li > span {
+    width: calc(100% - 1.75rem - 0.5rem);
 }
+
 .tsd-page-navigation ul {
     padding-left: 1.75rem;
 }
@@ -745,28 +769,31 @@ a.tsd-index-link {
     align-items: center;
     color: var(--color-text);
 }
+.tsd-accordion-summary {
+    list-style-type: none;
+    display: flex;
+    align-items: center;
+}
 .tsd-accordion-summary,
 .tsd-accordion-summary a {
     user-select: none;
     -moz-user-select: none;
     -webkit-user-select: none;
     -ms-user-select: none;
 
-    display: flex;
-    align-items: center;
     cursor: pointer;
 }
+.tsd-accordion-summary a {
+    flex-grow: 1;
+}
 .tsd-accordion-summary > * {
     margin-top: 0;
     margin-bottom: 0;
     padding-top: 0;
     padding-bottom: 0;
 }
-.tsd-accordion-summary::-webkit-details-marker {
-    display: none;
-}
-.tsd-index-accordion .tsd-accordion-summary svg {
-    margin-right: 0.25rem;
+.tsd-index-accordion .tsd-accordion-summary > svg {
+    margin-left: 0.25rem;
 }
 .tsd-index-content > :not(:first-child) {
     margin-top: 0.75rem;

diff --git a/docs/typedoc/functions/createAllPromise.html b/docs/typedoc/functions/createAllPromise.html
@@ -25,16 +25,10 @@ <h1>Function createAllPromise</h1></div>
 It rejects immediately upon any of the input promises rejected or non-promises throwing an error,
 and will reject with this first rejection message / error.
 If the runtime doesn&#39;t support the Promise.all it will fallback back to an asynchronous Promise implementation.</p>
-
-<h3>Returns</h3><ul>
-<li> An already resolved `Promise`, if the input passed is empty.
-<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
-(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
-promises reject.
-</ul></div>
-<section class="tsd-panel tsd-type-parameters">
+</div>
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">
@@ -46,7 +40,12 @@ <h5><span class="tsd-kind-parameter">input</span>: <span class="tsd-signature-ty
 </div></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
+<li> An already resolved `Promise`, if the input passed is empty.
+<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
+(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
+promises reject.
+</ul><aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/nevware21/ts-async/blob/main/lib/src/promise/promise.ts#L67">lib/src/promise/promise.ts:67</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">

diff --git a/docs/typedoc/functions/createAsyncAllPromise.html b/docs/typedoc/functions/createAsyncAllPromise.html
@@ -26,16 +26,10 @@ <h1>Function createAsyncAllPromise</h1></div>
 and will reject with this first rejection message / error.
 When resolved or rejected any additional chained operations will execute <strong>asynchronously</strong> using the optional
 timeout value to schedul when the chained item will be executed (eg. <code>then()</code>; <code>catch()</code>; <code>finally()</code>).</p>
-
-<h3>Returns</h3><ul>
-<li> An already resolved `Promise`, if the input passed is empty.
-<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
-(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
-promises reject.
-</ul></div>
-<section class="tsd-panel tsd-type-parameters">
+</div>
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">
@@ -47,7 +41,12 @@ <h5><span class="tsd-kind-parameter">input</span>: <span class="tsd-signature-ty
 </div></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
+<li> An already resolved `Promise`, if the input passed is empty.
+<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
+(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
+promises reject.
+</ul><aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/nevware21/ts-async/blob/main/lib/src/promise/asyncPromise.ts#L47">lib/src/promise/asyncPromise.ts:47</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">

diff --git a/docs/typedoc/functions/createAsyncPromise.html b/docs/typedoc/functions/createAsyncPromise.html
@@ -22,9 +22,9 @@ <h1>Function createAsyncPromise</h1></div>
 <div class="tsd-comment tsd-typography"><p>Creates an asynchronous Promise instance that when resolved or rejected will execute it&#39;s pending chained operations
 <strong>asynchronously</strong> using the optional provided timeout value to schedule when the chained items will be ececuted.</p>
 </div>
-<section class="tsd-panel tsd-type-parameters">
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">

diff --git a/docs/typedoc/functions/createAsyncRejectedPromise.html b/docs/typedoc/functions/createAsyncRejectedPromise.html
@@ -23,9 +23,9 @@ <h1>Function createAsyncRejectedPromise</h1></div>
 Any chained operations will execute <strong>asynchronously</strong> using the optional timeout value to schedule
 when then chained items will be executed. (eg. <code>catch()</code>; <code>finally()</code>).</p>
 </div>
-<section class="tsd-panel tsd-type-parameters">
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
 <div class="tsd-parameters">

diff --git a/docs/typedoc/functions/createAsyncResolvedPromise.html b/docs/typedoc/functions/createAsyncResolvedPromise.html
@@ -24,9 +24,9 @@ <h1>Function createAsyncResolvedPromise</h1></div>
 If a new instance is returned then any chained operations will execute <strong>asynchronously</strong> using the optional
 timeout value to schedule when the chained items will be executed.(eg. <code>then()</code>; <code>finally()</code>).</p>
 </div>
-<section class="tsd-panel tsd-type-parameters">
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">

diff --git a/docs/typedoc/functions/createIdleAllPromise.html b/docs/typedoc/functions/createIdleAllPromise.html
@@ -28,16 +28,10 @@ <h1>Function createIdleAllPromise</h1></div>
 When resolved or rejected any additional chained operations will execute <strong>asynchronously</strong> using
 the <code>requestIdleCallback</code> API (if available) with the optional provided timeout value to schedule
 when the chained items will be executed. (eg. <code>then()</code>; <code>catch()</code>; <code>finally()</code>).</p>
-
-<h3>Returns</h3><ul>
-<li> An already resolved `Promise`, if the input passed is empty.
-<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
-(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
-promises reject.
-</ul></div>
-<section class="tsd-panel tsd-type-parameters">
+</div>
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">
@@ -49,7 +43,12 @@ <h5><span class="tsd-kind-parameter">input</span>: <span class="tsd-signature-ty
 </div></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <a href="../interfaces/IPromise.html" class="tsd-signature-type tsd-kind-interface">IPromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
+<li> An already resolved `Promise`, if the input passed is empty.
+<li> A pending `Promise` in all other cases. This returned promise is then resolved/rejected __synchronously__
+(as soon as the pending items is empty) when all the promises in the given input have resolved, or if any of the
+promises reject.
+</ul><aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/nevware21/ts-async/blob/main/lib/src/promise/idlePromise.ts#L68">lib/src/promise/idlePromise.ts:68</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">

diff --git a/docs/typedoc/functions/createIdlePromise.html b/docs/typedoc/functions/createIdlePromise.html
@@ -24,9 +24,9 @@ <h1>Function createIdlePromise</h1></div>
 schedule when the chained items will be executed. When <code>requestIdleCallback</code> is not available this becomes the same as
 <code>createAsyncPromise</code> which uses <code>setTimeout</code> to schedule executions.</p>
 </div>
-<section class="tsd-panel tsd-type-parameters">
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
 <div class="tsd-parameters">

diff --git a/docs/typedoc/functions/createIdleRejectedPromise.html b/docs/typedoc/functions/createIdleRejectedPromise.html
@@ -24,9 +24,9 @@ <h1>Function createIdleRejectedPromise</h1></div>
 (if available) with the optional provided timeout value to schedule when the chained items will
 be executed. (eg. <code>catch()</code>; <code>finally()</code>).</p>
 </div>
-<section class="tsd-panel tsd-type-parameters">
+<section class="tsd-panel">
 <h4>Type Parameters</h4>
-<ul class="tsd-type-parameters">
+<ul class="tsd-type-parameter-list">
 <li>
 <h4><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
 <div class="tsd-parameters">