Skip to content

Commit 21c6fef

Browse files
committed
Update readme.
1 parent bcc3b2b commit 21c6fef

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,35 +45,36 @@ API
4545
===
4646
Docs generated using [`docts`](https://github.com/charto/docts)
4747

48+
4849
>
4950
> <a name="api-Task"></a>
5051
> ### Class [`Task`](#api-Task)
5152
> <em>Task wraps a promise, delaying it until some resource gets less busy.</em>
52-
> Source code: [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L18-L52)
53+
> Source code: [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L49-L80)
5354
>
5455
> Methods:
55-
> > **new( )** <sup>&rArr; <code>[Task](#api-Task)&lt;PromiseType&gt;</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L19-L21)
56+
> > **new( )** <sup>&rArr; <code>[Task](#api-Task)&lt;PromiseType&gt;</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L50-L53)
5657
> > &emsp;&#x25aa; func <sup><code>() =&gt; PromiseType</code></sup>
57-
> > **.delay( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L25-L34)
58+
> > &emsp;&#x25aa; Promise <sup><code>[PromisyClass](#api-PromisyClass)&lt;PromiseType&gt;</code></sup>
59+
> > **.delay( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L57-L66)
5860
> > &emsp;<em>Wrap task result in a new promise so it can be resolved later.</em>
59-
> > &emsp;&#x25aa; Promise <sup><code>PromisyClass&lt;PromiseType&gt;</code></sup>
60-
> > **.resume( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L38-L45)
61+
> > **.resume( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L70-L72)
6162
> > &emsp;<em>Start the task and call onFinish when done.</em>
6263
> > &emsp;&#x25aa; onFinish <sup><code>() =&gt; void</code></sup>
6364
>
6465
> <a name="api-TaskQueue"></a>
6566
> ### Class [`TaskQueue`](#api-TaskQueue)
66-
> Source code: [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L6-L64)
67+
> Source code: [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L6-L60)
6768
>
6869
> Methods:
69-
> > **new( )** <sup>&rArr; <code>[TaskQueue](#api-TaskQueue)&lt;PromiseType&gt;</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L7-L11)
70-
> > &emsp;&#x25aa; Promise <sup><code>PromisyClass&lt;PromiseType&gt;</code></sup>
70+
> > **new( )** <sup>&rArr; <code>[TaskQueue](#api-TaskQueue)&lt;PromiseType&gt;</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L7-L11)
71+
> > &emsp;&#x25aa; Promise <sup><code>[PromisyClass](#api-PromisyClass)&lt;PromiseType&gt;</code></sup>
7172
> > &emsp;&#x25aa; concurrency <sup><code>number</code></sup>
72-
> > **.add( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L16-L37)
73+
> > **.add( )** <sup>&rArr; <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L16-L33)
7374
> > &emsp;<em>Add a new task to the queue.</em>
7475
> > &emsp;<em>It will start when the number of other concurrent tasks is low enough.</em>
7576
> > &emsp;&#x25aa; func <sup><code>() =&gt; PromiseType</code></sup>
76-
> > **.wrap( )** <sup>&rArr; <code>(...args: any[]) =&gt; PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L42-L44)
77+
> > **.wrap( )** <sup>&rArr; <code>(...args: any[]) =&gt; PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L38-L40)
7778
> > &emsp;<em>Wrap a function returning a promise, so that before running</em>
7879
> > &emsp;<em>it waits until concurrent invocations are below this queue's limit.</em>
7980
> > &emsp;&#x25aa; func <sup><code>(...args: any[]) =&gt; PromiseType</code></sup>

0 commit comments

Comments
 (0)