https://github.com/tpaksu/jquery.promisque

A lightweight (1KB) jQuery promises (deferreds) queue system. Can run n queues in parallel at a time. Can be paused, resumed and cleared.
https://github.com/tpaksu/jquery.promisque

deferred deferred-queue jquery promise queue

Last synced: 12 days ago
JSON representation

A lightweight (1KB) jQuery promises (deferreds) queue system. Can run n queues in parallel at a time. Can be paused, resumed and cleared.

• Host: GitHub
• URL: https://github.com/tpaksu/jquery.promisque
• Owner: tpaksu
• License: unlicense
• Created: 2019-02-05T12:08:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-12T19:57:00.000Z (almost 6 years ago)
• Last Synced: 2024-10-30T00:49:07.516Z (2 months ago)
• Topics: deferred, deferred-queue, jquery, promise, queue
• Language: JavaScript
• Homepage:
• Size: 40 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jquery.promisque

A jQuery based promise queue which queues promises to run N by N in parallel.

Can be used in two methods:

- Run N items and wait for all of them to finish, then run N items again

  (anything but "pipe" mode, default)

- Run N items and once one of it finishes, run the next job on queue, run N jobs in parallel until queue gets empty.

  ("pipe" mode)

### Methods

- **push(callback, arg1, arg2, ..)** : pushes a new promise to the queue, can be pushed while running or stopped. Can use the given args in the callback.

- **next()** : gets the next item from the queue and removes it, if queue is empty returns null. It's an internal method, but if you need to skip an item from the stack, you can use it.

- **run(count[, mode])** : runs the queue, if mode is empty, the default method is used, after pause, it resumes the queue

- **pause()** : pauses the queue after current promises are finished

- **clear()** : clears the queue

- **stop()** : stops and clears the queue

### Example

    var queue = new Promisque();

    queue.push( Promise1 );

    queue.push(Promise2);

    queue.push(PromiseN);

    queue.run(4, "pipe");

 or just:

    (new Promisque()).push(Promise1).push(Promise2).push(PromiseN).run(4, "pipe");

    

### License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or

distribute this software, either in source code form or as a compiled

binary, for any purpose, commercial or non-commercial, and by any

means.

In jurisdictions that recognize copyright laws, the author or authors

of this software dedicate any and all copyright interest in the

software to the public domain. We make this dedication for the benefit

of the public at large and to the detriment of our heirs and

successors. We intend this dedication to be an overt act of

relinquishment in perpetuity of all present and future rights to this

software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR

OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,

ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to