deferred.fail.xml

<?xml version="1.0"?>
<entry name="deferred.fail" type="method" return="Deferred">
  <title>deferred.fail()</title>
  <signature>
    <added>1.5</added>
    <argument name="failCallbacks" type="Function">
      <desc>
        A function, or array of functions, that are called when the Deferred is rejected.
      </desc>
    </argument>
    <argument name="failCallbacks" type="Function" optional="true">
      <desc>
        Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
      </desc>
    </argument>
  </signature>
  <desc> Add handlers to be called when the Deferred object is rejected. </desc>
  <longdesc>
    <p>The <code>deferred.fail()</code> method accepts one or more arguments, all of which can be either a single function or an array of functions. When the Deferred is rejected, the failCallbacks are called. Callbacks are executed in the order they were added. Since <code>deferred.fail()</code> returns the deferred object, other methods of the deferred object can be chained to this one, including additional <code>deferred.fail()</code> methods. The failCallbacks are executed using the arguments provided to the <a href="deferred.reject"><code>deferred.reject()</code></a> or <a href="deferred.rejectWith"><code>deferred.rejectWith()</code></a> method call in the order they were added. For more information, see the documentation for <a href="/category/deferred-object/">Deferred object</a>.</p>
  </longdesc>
  <example>
    <desc>Since the <a href="http://api.jquery.com/jQuery.get/"><code>jQuery.get</code></a> method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the <code>deferred.done()</code> and <code>deferred.fail()</code> methods.</desc>
    <code><![CDATA[
$.get("test.php")
  .done(function(){ alert("$.get succeeded"); })
  .fail(function(){ alert("$.get failed!"); });
]]></code>
  </example>
  <category slug="deferred-object"/>
  <category slug="version/1.5"/>
</entry>