Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mceachen
mceachen committed Mar 14, 2019
1 parent 4826a0e commit 26b3d18
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/CNAME
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
batch-cluster.js.org
batch-cluster.js.org
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

36 changes: 30 additions & 6 deletions docs/classes/batchcluster.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ <h3>Accessors</h3>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#busyprocs" class="tsd-kind-icon">busy<wbr>Procs</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#ended" class="tsd-kind-icon">ended</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#internalerrorcount" class="tsd-kind-icon">internal<wbr>Error<wbr>Count</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#isidle" class="tsd-kind-icon">is<wbr>Idle</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#meantasksperproc" class="tsd-kind-icon">mean<wbr>Tasks<wbr>Per<wbr>Proc</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#pendingtasks" class="tsd-kind-icon">pending<wbr>Tasks</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="batchcluster.html#spawnedprocs" class="tsd-kind-icon">spawned<wbr>Procs</a></li>
Expand Down Expand Up @@ -179,7 +180,7 @@ <h3>busy<wbr>Procs</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L165">BatchCluster.ts:165</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L172">BatchCluster.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -216,7 +217,7 @@ <h3>internal<wbr>Error<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L173">BatchCluster.ts:173</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L180">BatchCluster.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -228,6 +229,26 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isidle" class="tsd-anchor"></a>
<h3>is<wbr>Idle</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isIdle<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L144">BatchCluster.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true if all previously-enqueued tasks have settled</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="meantasksperproc" class="tsd-anchor"></a>
<h3>mean<wbr>Tasks<wbr>Per<wbr>Proc</h3>
Expand All @@ -238,7 +259,7 @@ <h3>mean<wbr>Tasks<wbr>Per<wbr>Proc</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L151">BatchCluster.ts:151</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L158">BatchCluster.ts:158</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -258,7 +279,7 @@ <h3>pending<wbr>Tasks</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L144">BatchCluster.ts:144</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L151">BatchCluster.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -278,7 +299,7 @@ <h3>spawned<wbr>Procs</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L158">BatchCluster.ts:158</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L165">BatchCluster.ts:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -751,7 +772,7 @@ <h3>pids</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L207">BatchCluster.ts:207</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchCluster.ts#L214">BatchCluster.ts:214</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -796,6 +817,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="batchcluster.html#internalerrorcount" class="tsd-kind-icon">internal<wbr>Error<wbr>Count</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="batchcluster.html#isidle" class="tsd-kind-icon">is<wbr>Idle</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="batchcluster.html#meantasksperproc" class="tsd-kind-icon">mean<wbr>Tasks<wbr>Per<wbr>Proc</a>
</li>
Expand Down
21 changes: 21 additions & 0 deletions docs/classes/batchclusteroptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ <h2>Index</h2>
<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#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>
Expand All @@ -107,6 +108,23 @@ <h3>Properties</h3>
</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 name="cleanupchildprocs" class="tsd-anchor"></a>
<h3>cleanup<wbr>Child<wbr>Procs</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"> =&nbsp;true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L122">BatchClusterOptions.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should batch-cluster try to clean up after spawned processes that don&#39;t
shut down?</p>
</div>
<p>Only disable this if you have another means of PID cleanup.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="endgracefulwaittimemillis" class="tsd-anchor"></a>
<h3>end<wbr>Graceful<wbr>Wait<wbr>Time<wbr>Millis</h3>
Expand Down Expand Up @@ -315,6 +333,9 @@ <h3>task<wbr>Timeout<wbr>Millis</h3>
<li class="current tsd-kind-class">
<a href="batchclusteroptions.html" class="tsd-kind-icon">Batch<wbr>Cluster<wbr>Options</a>
<ul>
<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>
Expand Down
4 changes: 2 additions & 2 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h3>All<wbr>Opts</h3>
<div class="tsd-signature tsd-kind-icon">All<wbr>Opts<span class="tsd-signature-symbol">:</span> <a href="classes/batchclusteroptions.html" class="tsd-signature-type">BatchClusterOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/internalbatchprocessoptions.html" class="tsd-signature-type">InternalBatchProcessOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/childprocessfactory.html" class="tsd-signature-type">ChildProcessFactory</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L117">BatchClusterOptions.ts:117</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L125">BatchClusterOptions.ts:125</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -1239,7 +1239,7 @@ <h3>verify<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L127">BatchClusterOptions.ts:127</a></li>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L135">BatchClusterOptions.ts:135</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
22 changes: 22 additions & 0 deletions docs/interfaces/internalbatchprocessoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="internalbatchprocessoptions.html#cleanupchildprocs" class="tsd-kind-icon">cleanup<wbr>Child<wbr>Procs</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="internalbatchprocessoptions.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-interface tsd-is-inherited"><a href="internalbatchprocessoptions.html#exitcommand" class="tsd-kind-icon">exit<wbr>Command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="internalbatchprocessoptions.html#fail" class="tsd-kind-icon">fail</a></li>
Expand All @@ -108,6 +109,24 @@ <h3>Properties</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="cleanupchildprocs" class="tsd-anchor"></a>
<h3>cleanup<wbr>Child<wbr>Procs</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"> =&nbsp;true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/batchclusteroptions.html">BatchClusterOptions</a>.<a href="../classes/batchclusteroptions.html#cleanupchildprocs">cleanupChildProcs</a></p>
<ul>
<li>Defined in <a href="https://github.com/mceachen/batch-cluster.js/blob/master/src/BatchClusterOptions.ts#L122">BatchClusterOptions.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should batch-cluster try to clean up after spawned processes that don&#39;t
shut down?</p>
</div>
<p>Only disable this if you have another means of PID cleanup.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="endgracefulwaittimemillis" class="tsd-anchor"></a>
<h3>end<wbr>Graceful<wbr>Wait<wbr>Time<wbr>Millis</h3>
Expand Down Expand Up @@ -417,6 +436,9 @@ <h3>version<wbr>Command</h3>
<li class="current tsd-kind-interface">
<a href="internalbatchprocessoptions.html" class="tsd-kind-icon">Internal<wbr>Batch<wbr>Process<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="internalbatchprocessoptions.html#cleanupchildprocs" class="tsd-kind-icon">cleanup<wbr>Child<wbr>Procs</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="internalbatchprocessoptions.html#endgracefulwaittimemillis" class="tsd-kind-icon">end<wbr>Graceful<wbr>Wait<wbr>Time<wbr>Millis</a>
</li>
Expand Down

0 comments on commit 26b3d18

Please sign in to comment.