Skip to content

Commit

Permalink
fix API links (typedoc changed their URLs!)
Browse files Browse the repository at this point in the history
  • Loading branch information
mceachen committed Mar 2, 2022
1 parent f2ee725 commit 4381a24
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 24 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,31 +50,33 @@ The child process must use `stdin` and `stdout` for control/response.
BatchCluster will ensure a given process is only given one task at a time.

1. Create a singleton instance of
[BatchCluster](https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html).
[BatchCluster](https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html).

Note the [constructor
options](https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html#constructor)
options](https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html#constructor)
takes a union type of

- [ChildProcessFactory](https://photostructure.github.io/batch-cluster.js/interfaces/childprocessfactory.html)
- [ChildProcessFactory](https://photostructure.github.io/batch-cluster.js/interfaces/ChildProcessFactory.html)
and
- [BatchProcessOptions](https://photostructure.github.io/batch-cluster.js/interfaces/batchprocessoptions.html),
- [BatchProcessOptions](https://photostructure.github.io/batch-cluster.js/interfaces/BatchProcessOptions.html),
both of which have no defaults, and
- [BatchClusterOptions](https://photostructure.github.io/batch-cluster.js/classes/batchclusteroptions.html),
- [BatchClusterOptions](https://photostructure.github.io/batch-cluster.js/classes/BatchClusterOptions.html),
which has defaults that may or may not be relevant to your application.

1. The [default](https://photostructure.github.io/batch-cluster.js/modules.html#logger) logger
1. The [default logger](https://photostructure.github.io/batch-cluster.js/interfaces/Logger.html)
writes warning and error messages to `console.warn` and `console.error`. You
can change this to your logger by using
[setLogger](https://photostructure.github.io/batch-cluster.js/modules.html#setlogger).
[setLogger](https://photostructure.github.io/batch-cluster.js/modules.html#setLogger) or by providing a logger to the `BatchCluster` constructor.

1. Implement the [Parser](https://photostructure.github.io/batch-cluster.js/interfaces/parser.html)
1. Implement the [Parser](https://photostructure.github.io/batch-cluster.js/interfaces/Parser.html)
class to parse results from your child process.

1. Construct a [Task](https://photostructure.github.io/batch-cluster.js/classes/task.html) with the desired command and
the parser you built in the previous step, and submit it to your BatchCluster
singleton's
[enqueueTask](https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html#enqueuetask) method.
1. Construct or extend the
[Task](https://photostructure.github.io/batch-cluster.js/classes/Task.html)
class with the desired command and the parser you built in the previous
step, and submit it to your BatchCluster's
[enqueueTask](https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html#enqueueTask)
method.

See
[src/test.ts](https://github.com/photostructure/batch-cluster.js/blob/main/src/test.ts)
Expand Down
26 changes: 14 additions & 12 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,31 +45,33 @@ <h2>Usage</h2>
BatchCluster will ensure a given process is only given one task at a time.</p>
<ol>
<li><p>Create a singleton instance of
<a href="https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html">BatchCluster</a>.</p>
<p>Note the <a href="https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html#constructor">constructor
<a href="https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html">BatchCluster</a>.</p>
<p>Note the <a href="https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html#constructor">constructor
options</a>
takes a union type of</p>
<ul>
<li><a href="https://photostructure.github.io/batch-cluster.js/interfaces/childprocessfactory.html">ChildProcessFactory</a>
<li><a href="https://photostructure.github.io/batch-cluster.js/interfaces/ChildProcessFactory.html">ChildProcessFactory</a>
and</li>
<li><a href="https://photostructure.github.io/batch-cluster.js/interfaces/batchprocessoptions.html">BatchProcessOptions</a>,
<li><a href="https://photostructure.github.io/batch-cluster.js/interfaces/BatchProcessOptions.html">BatchProcessOptions</a>,
both of which have no defaults, and</li>
<li><a href="https://photostructure.github.io/batch-cluster.js/classes/batchclusteroptions.html">BatchClusterOptions</a>,
<li><a href="https://photostructure.github.io/batch-cluster.js/classes/BatchClusterOptions.html">BatchClusterOptions</a>,
which has defaults that may or may not be relevant to your application.</li>
</ul>
</li>
<li><p>The <a href="https://photostructure.github.io/batch-cluster.js/modules.html#logger">default</a> logger
<li><p>The <a href="https://photostructure.github.io/batch-cluster.js/interfaces/Logger.html">default logger</a>
writes warning and error messages to <code>console.warn</code> and <code>console.error</code>. You
can change this to your logger by using
<a href="https://photostructure.github.io/batch-cluster.js/modules.html#setlogger">setLogger</a>.</p>
<a href="https://photostructure.github.io/batch-cluster.js/modules.html#setLogger">setLogger</a> or by providing a logger to the <code>BatchCluster</code> constructor.</p>
</li>
<li><p>Implement the <a href="https://photostructure.github.io/batch-cluster.js/interfaces/parser.html">Parser</a>
<li><p>Implement the <a href="https://photostructure.github.io/batch-cluster.js/interfaces/Parser.html">Parser</a>
class to parse results from your child process.</p>
</li>
<li><p>Construct a <a href="https://photostructure.github.io/batch-cluster.js/classes/task.html">Task</a> with the desired command and
the parser you built in the previous step, and submit it to your BatchCluster
singleton&#39;s
<a href="https://photostructure.github.io/batch-cluster.js/classes/batchcluster.html#enqueuetask">enqueueTask</a> method.</p>
<li><p>Construct or extend the
<a href="https://photostructure.github.io/batch-cluster.js/classes/Task.html">Task</a>
class with the desired command and the parser you built in the previous
step, and submit it to your BatchCluster&#39;s
<a href="https://photostructure.github.io/batch-cluster.js/classes/BatchCluster.html#enqueueTask">enqueueTask</a>
method.</p>
</li>
</ol>
<p>See
Expand Down

0 comments on commit 4381a24

Please sign in to comment.