jquery.ajaxq

jQuery plugin for AJAX queueing.

This extension can be used also with Zepto.js.

Get the latest version on GitHub

Download

Download jquery.ajaxq.js or minified jquery.ajaxq.min.js

Also you can install this plugin via npm or bower $ npm install jquery.ajaxq or $ bower install jquery.ajaxq

Usage documentation

$.ajaxq(url, [settings])

Method $.ajaxq always return $.ajaxq.Request instance what behaves like jqXHR.

All queries will be executed in strict sequence. The second request will be started only after finishing first one.

  
  var 
    req1 = $.ajaxq({
      url: '/url1',
      type: 'post'
    }),
    
    req2 = $.ajaxq({
      url: '/url2',
      type: 'get',
      dataType: 'json'
    }),

    req3 = $.ajaxq({
      url: '/url3'
    });

    req1.done(function() { /** do something on success */ })
    req2.abort();
    req3.fail(function() { /** do something on fail */ })

$.ajaxq.get

Adds request to main queue. Has the same signature as jQuery.get method.

  $.ajaxq.get('http://google.com', function(data) {
    // console.log(data)
  });

$.ajaxq.post

Adds request to main queue. Has the same signature as jQuery.post method.

$.ajaxq.getJSON( url [[,data], callback] )

Adds request to main queue. Has the same signature as jQuery.getJSON method.

$.ajaxq.Request(url, [settings])

$.ajaxq.Request(settings)

Method signature looks like jQuery.ajax:

Creates new $.ajaxq.Request instance. Which has all the methods that jqXHR (promised object) has. In addition new created object has method run() which starts execution of query.

  var req = $.ajaxq.Request({
    url: '/',
    success: function() { /** do something */ }
  });

  console.log(req.status);

  req.run(); // only after that $.ajax will be executed

$.ajaxq.Queue

Method signature $.ajaxq.Queue([bandwidth])

bandwidth - number of concurrent runable requests. Creates new $.ajaxq.Queue instance.

  
  // queues are independent one from another
  var 
    imagesQueue = $.ajaxq.Queue(1),
    postsQueue  = $.ajaxq.Queue(2);

  var 
    // firs img request will be started at once
    img1 = imagesQueue.ajax({
      url: '/img1.png'
    }),
    // second will be started after finishing first
    img2 = imagesQueue.ajax({
      url: '/img2.png'
    }),

    // the first and the second post queries will be started simultaneously
    post1 = postsQueue.ajax({
      url: '/post/1.json'
    }),
    post2 = postsQueue.ajax({
      url: '/post/2.json'
    }),

    // the third request fil be started after finishing one of (the first or the second)
    post3 = postsQueue.ajax({
      url: '/post/3.json'
    });

Queueing example

  var queue = new Queue(2);

  for (var i = 0, n = 200; i < n; i++) {
    var req = queue.ajax({
      url: '/ajax.php',
      data: {n: i}
    });

    if (i % 2) {
      req.abort();
    }
  };

  // ajax.php 

  usleep(rand(1000000, 3000000));

  header('Content-type: application/json');

  echo json_encode([
      'status' => true
  ]);

Results of execution above scripts.

Only two ajax requrest are executing simontaneously.