|
45 | 45 | === |
46 | 46 | Docs generated using [`docts`](https://github.com/charto/docts) |
47 | 47 |
|
| 48 | + |
48 | 49 | > |
49 | 50 | > <a name="api-Task"></a> |
50 | 51 | > ### Class [`Task`](#api-Task) |
51 | 52 | > <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) |
53 | 54 | > |
54 | 55 | > Methods: |
55 | | -> > **new( )** <sup>⇒ <code>[Task](#api-Task)<PromiseType></code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L19-L21) |
| 56 | +> > **new( )** <sup>⇒ <code>[Task](#api-Task)<PromiseType></code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L50-L53) |
56 | 57 | > >  ▪ func <sup><code>() => PromiseType</code></sup> |
57 | | -> > **.delay( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L25-L34) |
| 58 | +> >  ▪ Promise <sup><code>[PromisyClass](#api-PromisyClass)<PromiseType></code></sup> |
| 59 | +> > **.delay( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L57-L66) |
58 | 60 | > >  <em>Wrap task result in a new promise so it can be resolved later.</em> |
59 | | -> >  ▪ Promise <sup><code>PromisyClass<PromiseType></code></sup> |
60 | | -> > **.resume( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/Task.ts#L38-L45) |
| 61 | +> > **.resume( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/Task.ts#L70-L72) |
61 | 62 | > >  <em>Start the task and call onFinish when done.</em> |
62 | 63 | > >  ▪ onFinish <sup><code>() => void</code></sup> |
63 | 64 | > |
64 | 65 | > <a name="api-TaskQueue"></a> |
65 | 66 | > ### 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) |
67 | 68 | > |
68 | 69 | > Methods: |
69 | | -> > **new( )** <sup>⇒ <code>[TaskQueue](#api-TaskQueue)<PromiseType></code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L7-L11) |
70 | | -> >  ▪ Promise <sup><code>PromisyClass<PromiseType></code></sup> |
| 70 | +> > **new( )** <sup>⇒ <code>[TaskQueue](#api-TaskQueue)<PromiseType></code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L7-L11) |
| 71 | +> >  ▪ Promise <sup><code>[PromisyClass](#api-PromisyClass)<PromiseType></code></sup> |
71 | 72 | > >  ▪ concurrency <sup><code>number</code></sup> |
72 | | -> > **.add( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L16-L37) |
| 73 | +> > **.add( )** <sup>⇒ <code>PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L16-L33) |
73 | 74 | > >  <em>Add a new task to the queue.</em> |
74 | 75 | > >  <em>It will start when the number of other concurrent tasks is low enough.</em> |
75 | 76 | > >  ▪ func <sup><code>() => PromiseType</code></sup> |
76 | | -> > **.wrap( )** <sup>⇒ <code>(...args: any[]) => PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/99c8608/src/TaskQueue.ts#L42-L44) |
| 77 | +> > **.wrap( )** <sup>⇒ <code>(...args: any[]) => PromiseType</code></sup> [`<>`](http://github.com/charto/cwait/blob/bcc3b2b/src/TaskQueue.ts#L38-L40) |
77 | 78 | > >  <em>Wrap a function returning a promise, so that before running</em> |
78 | 79 | > >  <em>it waits until concurrent invocations are below this queue's limit.</em> |
79 | 80 | > >  ▪ func <sup><code>(...args: any[]) => PromiseType</code></sup> |
|
0 commit comments