Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mceachen
mceachen committed Apr 29, 2022
1 parent ed7ac34 commit b2195df
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 29 deletions.
4 changes: 2 additions & 2 deletions docs/assets/main.js
View file

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/assets/style.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -766,12 +766,13 @@ footer .tsd-legend {

.tsd-flag {
display: inline-block;
padding: 1px 5px;
padding: 0.25em 0.4em;
border-radius: 4px;
color: var(--color-comment-tag-text);
background-color: var(--color-comment-tag);
text-indent: 0;
font-size: 14px;
font-size: 75%;
line-height: 1;
font-weight: normal;
}

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/BatchCluster.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchCluster | batch-cluster</title><meta name="description" content="Documentation for batch-cluster"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">batch-cluster</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">batch-cluster</a></li><li><a href="BatchCluster.html">BatchCluster</a></li></ul><h1>Class BatchCluster</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchCluster | batch-cluster</title><meta name="description" content="Documentation for batch-cluster"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">batch-cluster</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">batch-cluster</a></li><li><a href="BatchCluster.html">BatchCluster</a></li></ul><h1>Class BatchCluster </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>BatchCluster instances manage 0 or more homogeneous child processes, and
provide the main interface for enqueuing <code>Task</code>s via <code>enqueueTask</code>.</p>
</div><div><p>Given the large number of configuration options, the constructor
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/BatchClusterOptions.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchClusterOptions | batch-cluster</title><meta name="description" content="Documentation for batch-cluster"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">batch-cluster</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">batch-cluster</a></li><li><a href="BatchClusterOptions.html">BatchClusterOptions</a></li></ul><h1>Class BatchClusterOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchClusterOptions | batch-cluster</title><meta name="description" content="Documentation for batch-cluster"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">batch-cluster</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">batch-cluster</a></li><li><a href="BatchClusterOptions.html">BatchClusterOptions</a></li></ul><h1>Class BatchClusterOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>These parameter values have somewhat sensible defaults, but can be
overridden for a given BatchCluster.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BatchClusterOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="BatchClusterOptions.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#cleanupChildProcs" class="tsd-kind-icon">cleanup<wbr/>Child<wbr/>Procs</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#endGracefulWaitTimeMillis" class="tsd-kind-icon">end<wbr/>Graceful<wbr/>Wait<wbr/>Time<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#healthCheckIntervalMillis" class="tsd-kind-icon">health<wbr/>Check<wbr/>Interval<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxFailedTasksPerProcess" class="tsd-kind-icon">max<wbr/>Failed<wbr/>Tasks<wbr/>Per<wbr/>Process</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxIdleMsPerProcess" class="tsd-kind-icon">max<wbr/>Idle<wbr/>Ms<wbr/>Per<wbr/>Process</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxProcAgeMillis" class="tsd-kind-icon">max<wbr/>Proc<wbr/>Age<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxProcs" class="tsd-kind-icon">max<wbr/>Procs</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxReasonableProcessFailuresPerMinute" class="tsd-kind-icon">max<wbr/>Reasonable<wbr/>Process<wbr/>Failures<wbr/>Per<wbr/>Minute</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#maxTasksPerProcess" class="tsd-kind-icon">max<wbr/>Tasks<wbr/>Per<wbr/>Process</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#minDelayBetweenSpawnMillis" class="tsd-kind-icon">min<wbr/>Delay<wbr/>Between<wbr/>Spawn<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#onIdleIntervalMillis" class="tsd-kind-icon">on<wbr/>Idle<wbr/>Interval<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#pidCheckIntervalMillis" class="tsd-kind-icon">pid<wbr/>Check<wbr/>Interval<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#spawnTimeoutMillis" class="tsd-kind-icon">spawn<wbr/>Timeout<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#streamFlushMillis" class="tsd-kind-icon">stream<wbr/>Flush<wbr/>Millis</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BatchClusterOptions.html#taskTimeoutMillis" class="tsd-kind-icon">task<wbr/>Timeout<wbr/>Millis</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><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></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Batch<wbr/>Cluster<wbr/>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BatchClusterOptions.html" class="tsd-signature-type" data-tsd-kind="Class">BatchClusterOptions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="BatchClusterOptions.html" class="tsd-signature-type" data-tsd-kind="Class">BatchClusterOptions</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="cleanupChildProcs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">cleanup<wbr/>Child<wbr/>Procs<a href="#cleanupChildProcs" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><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></svg></a></h3><div class="tsd-signature tsd-kind-icon">cleanup<wbr/>Child<wbr/>Procs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/photostructure/batch-cluster.js/blob/main/src/BatchClusterOptions.ts#L142">BatchClusterOptions.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
Expand Down
Loading

0 comments on commit b2195df

Please sign in to comment.