Why does JQuery.getJSON() have a success and a done function?

David Thielen picture David Thielen · Apr 14, 2014 · Viewed 23.5k times · Source

The JQuery documentation for getJSON shows an example of:

var jqxhr = $.getJSON( "example.json", function() {
  console.log( "success" );
})
  .done(function() {
    console.log( "second success" );
  })
  .fail(function() {
    console.log( "error" );
  })
  .always(function() {
    console.log( "complete" );
  });

What's the difference between the success function (passed as the 2nd parameter) the the done() function? They seem to be the same thing.

Answer

Denys Séguret picture Denys Séguret · Apr 14, 2014

Initially, jQuery asynchronous functions weren't returning promises, you had to use the callback.

Then they added the deferred (promise) system but kept the callbacks for compatibility (and because not everybody like deferred).

From the Deferred object documentation :

In JavaScript it is common to invoke functions that optionally accept callbacks that are called within that function. For example, in versions prior to jQuery 1.5, asynchronous processes such as jQuery.ajax() accept callbacks to be invoked some time in the near-future upon success, error, and completion of the ajax request.

jQuery.Deferred() introduces several enhancements to the way callbacks are managed and invoked. In particular, jQuery.Deferred() provides flexible ways to provide multiple callbacks, and these callbacks can be invoked regardless of whether the original callback dispatch has already occurred. jQuery Deferred is based on the CommonJS Promises/A design.