yarn docs

photostructure · May 10, 2023 · a73db0e · a73db0e
1 parent a6032ce
commit a73db0e
Show file tree

Hide file tree

Showing 11 changed files with 183 additions and 182 deletions.
diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/style.css b/docs/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,33 @@ a.tsd-index-link {
     align-items: center;
     color: var(--color-text);
 }
+.tsd-accordion-summary {
+    list-style-type: none; /* hide marker on non-safari */
+    outline: none; /* broken on safari, so just hide it */
+}
+.tsd-accordion-summary::-webkit-details-marker {
+    display: none; /* hide marker on safari */
+}
 .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 {
+    width: calc(100% - 1.5rem);
+}
 .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/classes/BatchCluster.html b/docs/classes/BatchCluster.html
diff --git a/docs/classes/BatchProcess.html b/docs/classes/BatchProcess.html
diff --git a/docs/classes/Deferred.html b/docs/classes/Deferred.html
@@ -20,9 +20,9 @@ <h1>Class Deferred&lt;T&gt;</h1></div>
 the context of the Promise construction. Also exposes the <code>pending</code>,
 <code>fulfilled</code>, or <code>rejected</code> state of the promise.</p>
 </div></section> 
-<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> 
 <section class="tsd-panel tsd-hierarchy">
@@ -72,9 +72,9 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="constructor.new_Deferred"><span class="tsd-kind-constructor-signature">new <wbr/>Deferred</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Deferred.html" class="tsd-signature-type tsd-kind-class">Deferred</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_Deferred" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
-<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>
 <h4 class="tsd-returns-title">Returns <a href="Deferred.html" class="tsd-signature-type tsd-kind-class">Deferred</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
@@ -99,43 +99,39 @@ <h3 class="tsd-anchor-link"><span>fulfilled</span><a href="#fulfilled" aria-labe
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="fulfilled.fulfilled-1"><span class="tsd-signature-symbol">get</span> fulfilled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography">
-<h3>Returns</h3><p><code>true</code> iff <code>resolve</code> has been invoked</p>
-</div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
+<div class="tsd-comment tsd-typography"></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> iff <code>resolve</code> has been invoked</p>
+<aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/photostructure/batch-cluster.js/blob/main/src/Deferred.ts#L39">Deferred.ts:39</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="pending" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>pending</span><a href="#pending" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="pending.pending-1"><span class="tsd-signature-symbol">get</span> pending<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography">
-<h3>Returns</h3><p><code>true</code> iff neither <code>resolve</code> nor <code>rejected</code> have been invoked</p>
-</div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
+<div class="tsd-comment tsd-typography"></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> iff neither <code>resolve</code> nor <code>rejected</code> have been invoked</p>
+<aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/photostructure/batch-cluster.js/blob/main/src/Deferred.ts#L32">Deferred.ts:32</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="rejected" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>rejected</span><a href="#rejected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="rejected.rejected-1"><span class="tsd-signature-symbol">get</span> rejected<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography">
-<h3>Returns</h3><p><code>true</code> iff <code>rejected</code> has been invoked</p>
-</div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
+<div class="tsd-comment tsd-typography"></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> iff <code>rejected</code> has been invoked</p>
+<aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/photostructure/batch-cluster.js/blob/main/src/Deferred.ts#L46">Deferred.ts:46</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="settled" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>settled</span><a href="#settled" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="settled.settled-1"><span class="tsd-signature-symbol">get</span> settled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography">
-<h3>Returns</h3><p><code>true</code> iff <code>resolve</code> or <code>rejected</code> have been invoked</p>
-</div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
+<div class="tsd-comment tsd-typography"></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> iff <code>resolve</code> or <code>rejected</code> have been invoked</p>
+<aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/photostructure/batch-cluster.js/blob/main/src/Deferred.ts#L53">Deferred.ts:53</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
@@ -145,9 +141,9 @@ <h3 class="tsd-anchor-link"><span>catch</span><a href="#catch" aria-label="Perma
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="catch.catch-1"><span class="tsd-kind-call-signature">catch</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onrejected</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><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-type tsd-kind-type-parameter">TResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#catch.catch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
-<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">TResult</span> = <span class="tsd-signature-type">never</span></h4></li></ul></section>
 <div class="tsd-parameters">
@@ -215,9 +211,9 @@ <h3 class="tsd-anchor-link"><span>then</span><a href="#then" aria-label="Permali
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="then.then-1"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TResult1</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TResult2</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onfulfilled</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">onrejected</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">TResult1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">TResult2</span><span class="tsd-signature-symbol">&gt;</span><a href="#then.then-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
-<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">TResult1</span> = <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li>
 <li>