diff --git a/page/ajax/jquery-ajax-methods.md b/page/ajax/jquery-ajax-methods.md index 1caaf189..54a62e1e 100644 --- a/page/ajax/jquery-ajax-methods.md +++ b/page/ajax/jquery-ajax-methods.md @@ -30,28 +30,26 @@ $.ajax({ // The type of data we expect back dataType : "json", +}) + // Code to run if the request succeeds (is done); + // The response is passed to the function + .done(function( json ) { + $( "

" ).text( json.title ).appendTo( "body" ); + $( "
").html( json.html ).appendTo( "body" ); + }) + // Code to run if the request fails; the raw request and + // status codes are passed to the function + .fail(function( xhr, status, errorThrown ) { + alert( "Sorry, there was a problem!" ); + console.log( "Error: " + errorThrown ); + console.log( "Status: " + status ); + console.dir( xhr ); + }) + // Code to run regardless of success or failure; + .always(function( xhr, status ) { + alert( "The request is complete!" ); + }); - // Code to run if the request succeeds; - // the response is passed to the function - success: function( json ) { - $( "

" ).text( json.title ).appendTo( "body" ); - $( "
").html( json.html ).appendTo( "body" ); - }, - - // Code to run if the request fails; the raw request and - // status codes are passed to the function - error: function( xhr, status, errorThrown ) { - alert( "Sorry, there was a problem!" ); - console.log( "Error: " + errorThrown ); - console.log( "Status: " + status ); - console.dir( xhr ); - }, - - // Code to run regardless of success or failure - complete: function( xhr, status ) { - alert( "The request is complete!" ); - } -}); ``` **Note:** Regarding the `dataType` setting, if the server sends back data that is in a different format than you specify, your code may fail, and the reason will not always be clear, because the HTTP response code will not show an error. When working with Ajax requests, make sure your server is sending back the data type you're asking for, and verify that the `Content-type` header is accurate for the data type. For example, for JSON data, the `Content-type` header should be `application/json`. @@ -68,7 +66,15 @@ Set to `false` if the request should be sent synchronously. Defaults to `true`. Whether to use a cached response if available. Defaults to `true` for all `dataType`s except "script" and "jsonp". When set to `false`, the URL will simply have a cachebusting parameter appended to it. -#### complete +#### done + +A callback function to run if the request succeeds. The function receives the response data (converted to a JavaScript object if the `dataType` was JSON), as well as the text status of the request and the raw request object. + +#### fail + +A callback function to run if the request results in an error. The function receives the raw request object and the text status of the request. + +#### always A callback function to run when the request is complete, regardless of success or failure. The function receives the raw request object and the text status of the request. @@ -84,17 +90,10 @@ The data to be sent to the server. This can either be an object or a query strin The type of data you expect back from the server. By default, jQuery will look at the MIME type of the response if no `dataType` is specified. -#### error - -A callback function to run if the request results in an error. The function receives the raw request object and the text status of the request. - #### jsonp The callback name to send in a query string when making a JSONP request. Defaults to "callback". -#### success - -A callback function to run if the request succeeds. The function receives the response data (converted to a JavaScript object if the `dataType` was JSON), as well as the text status of the request and the raw request object. #### timeout diff --git a/page/code-organization/deferreds/examples.md b/page/code-organization/deferreds/examples.md index e619e793..d4b74e38 100644 --- a/page/code-organization/deferreds/examples.md +++ b/page/code-organization/deferreds/examples.md @@ -39,7 +39,7 @@ $.cachedGetScript = function( url, callback ) { }; ``` -One promise is cached per URL. If there is no promise for the given URL yet, then a deferred is created and the request is issued. If it already exists, however, the callback is attached to the existing deferred. The big advantage of this solution is that it will handle both complete and inbound requests transparently. Another advantage is that a deferred-based cache will deal with failure gracefully. The promise will end up rejected which can be tested for by providing an error callback: +One promise is cached per URL. If there is no promise for the given URL yet, then a deferred is created and the request is issued. When the request is complete, the deferred is resolved (with `defer.resolve`); if an error occurs, the deferred is rejected (with `defer.reject`). If the promise already exists, the callback is attached to the existing deferred; otherwise, the promise is first created and then the callback is attached. The big advantage of this solution is that it will handle both complete and inbound requests transparently. Another advantage is that a deferred-based cache will deal with failure gracefully. The promise will end up rejected which can be tested for by providing an error callback: ``` $.cachedGetScript( url ).then( successCallback, errorCallback );