/**
* Attach a function to be executed whenever an AJAX request completes.
*
- * @example $("#msg").ajaxComplete(function(){
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxComplete(function(request, settings){
* $(this).append("<li>Request Complete.</li>");
* });
* @desc Show a message when an AJAX request completes.
* Attach a function to be executed whenever an AJAX request completes
* successfully.
*
- * @example $("#msg").ajaxSuccess(function(){
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxSuccess(function(request, settings){
* $(this).append("<li>Successful Request!</li>");
* });
* @desc Show a message when an AJAX request completes successfully.
/**
* Attach a function to be executed whenever an AJAX request fails.
*
- * @example $("#msg").ajaxError(function(){
- * $(this).append("<li>Error requesting page.</li>");
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxError(function(request, settings){
+ * $(this).append("<li>Error requesting page " + settings.url + "</li>");
* });
* @desc Show a message when an AJAX request fails.
*
* @param Function callback The function to execute.
* @cat AJAX
*/
+
+/**
+ * Attach a function to be executed before an AJAX request is send.
+ *
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxSend(function(request, settings){
+ * $(this).append("<li>Starting request at " + settings.url + "</li>");
+ * });
+ * @desc Show a message before an AJAX request is send.
+ *
+ * @name ajaxSend
+ * @type jQuery
+ * @param Function callback The function to execute.
+ * @cat AJAX
+ */
new function(){
- var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(",");
+ var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(",");
for ( var i = 0; i < e.length; i++ ) new function(){
var o = e[i];
// Allow custom headers/mimetypes
if( s.beforeSend )
s.beforeSend(xml);
+ if (s.global)
+ jQuery.event.trigger("ajaxSend", [xml, s]);
// Wait for a response to come back
var onreadystatechange = function(isTimeout){
// Fire the global callback
if( s.global )
- jQuery.event.trigger( "ajaxSuccess" );
+ jQuery.event.trigger( "ajaxSuccess", [xml, s] );
// Otherwise, the request was not successful
} else {
// Fire the global callback
if( s.global )
- jQuery.event.trigger( "ajaxError" );
+ jQuery.event.trigger( "ajaxError", [xml, s] );
}
// The request was completed
if( s.global )
- jQuery.event.trigger( "ajaxComplete" );
+ jQuery.event.trigger( "ajaxComplete", [xml, s] );
// Handle the global AJAX counter
if ( s.global && ! --jQuery.active )
});
test("test global handlers - success", function() {
- expect(6);
+ expect(8);
stop();
- var counter = { complete: 0, success: 0, error: 0 },
+ var counter = { complete: 0, success: 0, error: 0, send: 0 },
success = function() { counter.success++ },
error = function() { counter.error++ },
- complete = function() { counter.complete++ };
+ complete = function() { counter.complete++ },
+ send = function() { counter.send++ };
- $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success);
+ $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxSend(send).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success);
// start with successful test
- $.ajax({url: "data/name.php", success: success, error: error, complete: function() {
+ $.ajax({url: "data/name.php", beforeSend: send, success: success, error: error, complete: function() {
ok( counter.error == 0, 'Check succesful request' );
ok( counter.success == 2, 'Check succesful request' );
ok( counter.complete == 3, 'Check succesful request' );
- counter.error = counter.success = counter.complete = 0;
+ ok( counter.send == 2, 'Check succesful request' );
+ counter.error = counter.success = counter.complete = counter.send = 0;
$.ajaxTimeout(500);
- $.ajax({url: "data/name.php?wait=5", success: success, error: error, complete: function() {
+ $.ajax({url: "data/name.php?wait=5", beforeSend: send, success: success, error: error, complete: function() {
ok( counter.error == 2, 'Check failed request' );
ok( counter.success == 0, 'Check failed request' );
ok( counter.complete == 3, 'Check failed request' );
+ ok( counter.send == 2, 'Check failed request' );
start();
}});
}});
});
test("test global handlers - failure", function() {
- expect(6);
+ expect(8);
stop();
- var counter = { complete: 0, success: 0, error: 0 },
+ var counter = { complete: 0, success: 0, error: 0, send: 0 },
success = function() { counter.success++ },
- error = function() { counter.error++ };
+ error = function() { counter.error++ },
+ complete = function() { counter.complete++ },
+ send = function() { counter.send++ };
$.ajaxTimeout(0);
- $.ajax({url: "data/name.php", global: false, success: success, error: error, complete: function() {
+ $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxSend(send).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success);
+ $.ajax({url: "data/name.php", global: false, beforeSend: send, success: success, error: error, complete: function() {
ok( counter.error == 0, 'Check sucesful request without globals' );
ok( counter.success == 1, 'Check sucesful request without globals' );
ok( counter.complete == 0, 'Check sucesful request without globals' );
- counter.error = counter.success = counter.complete = 0;
+ ok( counter.send == 1, 'Check sucesful request without globals' );
+ counter.error = counter.success = counter.complete = counter.send = 0;
$.ajaxTimeout(500);
- $.ajax({url: "data/name.php?wait=5", global: false, success: success, error: error, complete: function() {
+ $.ajax({url: "data/name.php?wait=5", global: false, beforeSend: send, success: success, error: error, complete: function() {
ok( counter.error == 1, 'Check failed request without globals' );
ok( counter.success == 0, 'Check failed request without globals' );
ok( counter.complete == 0, 'Check failed request without globals' );
+ ok( counter.send == 1, 'Check failed request without globals' );
start();
}});
}});
});
});
-test("$.ajax - preprocess", function() {
+test("$.ajax - beforeSend", function() {
expect(1);
stop();
var customHeader = "value";