pace-yourself


A priority queue and consumer

PriorityQueue

Class representing a priority queue

Kind: global class

* PriorityQueue
* [new PriorityQueue([priorities])](#new_PriorityQueue_new)
* [.enqueue(entry, [priority])](#PriorityQueue+enqueue) ⇒ promise
* .dequeue() ⇒ function

$3

constructor - Create a priority queue

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [priorities] | array | [1, 2] | An array of priority levels the queue should support from highest to lowest |

Example
``js
const queue = new PriorityQueue();
`


$3

enqueue - Enqueue a function

Kind: instance method of PriorityQueue
Returns: promise - A promise that resolves with enqueued function

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| entry | function | | The function to enqueue |
| [priority] | number | this.priorities[0] | The priority of the function to enqueue |

Example
`js
const queue = new PriorityQueue();
queue.enqueue(() => 'ayy', 2);
// → returns a promise that resolves with 'ayy'
`


$3

dequeue - Dequeue the next item in the highest priority queue with items

Kind: instance method of PriorityQueue
Returns: function - The dequeued function
Example
`js
const queue = new PriorityQueue();
queue.enqueue(() => 'lmao', 2).then(result => console.log(result));
queue.dequeue()();
// → resolves the promise, logging 'lmao'
`

QueueConsumer

Class representing a queue consumer

Kind: global class

* QueueConsumer
* [new QueueConsumer(queue, [delay])](#new_QueueConsumer_new)
* .start()
* .stop()

$3

constructor - Create a queue consumer

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| queue | PriorityQueue | | The queue to consume |
| [delay] | number | 2500 | The interval, in ms, to wait between dequeueing functions |

Example
`js
const queue = new PriorityQueue();
const consumer = new QueueConsumer(queue, 86400000);
`


$3

start - Start consuming the queue

Kind: instance method of QueueConsumer

$3

stop - Stop consuming the queue

Kind: instance method of QueueConsumer

Scripts

$3

`sh
npm run test
`

$3

`sh
npm run coverage
`

$3

`sh
npm run lint
`

$3

`sh
npm run readme
`

$3

`sh
npm run compile
``

License

MIT @ Flip