jQuery API Documentation

Categories: Deferred Object

The Deferred object, introduced in jQuery 1.5, is a chainable utility object created by calling the jQuery.Deferred() method. It can register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.

The Deferred object is chainable, similar to the way a jQuery object is chainable, but it has its own methods. After creating a Deferred object, you can use any of the methods below by either chaining directly from the object creation or saving the object in a variable and invoking one or more methods on that variable.

Deferred Object

deferred.always()

Add handlers to be called when the Deferred object is either resolved or rejected.

Deferred Object

deferred.catch()

Add handlers to be called when the Deferred object is rejected.

Deferred Object

deferred.done()

Add handlers to be called when the Deferred object is resolved.

Deferred Object

deferred.fail()

Add handlers to be called when the Deferred object is rejected.

Deferred Object | Deprecated > Deprecated 1.7 | Removed

deferred.isRejected()

Determine whether a Deferred object has been rejected.

Deferred Object | Deprecated > Deprecated 1.7 | Removed

deferred.isResolved()

Determine whether a Deferred object has been resolved.

Deferred Object

deferred.notify()

Call the progressCallbacks on a Deferred object with the given args.

Deferred Object

deferred.notifyWith()

Call the progressCallbacks on a Deferred object with the given context and args.

Deferred Object | Deprecated > Deprecated 1.8

deferred.pipe()

Utility method to filter and/or chain Deferreds.

Deferred Object

deferred.progress()

Add handlers to be called when the Deferred object generates progress notifications.

Deferred Object

deferred.promise()

Return a Deferred's Promise object.

Deferred Object

deferred.reject()

Reject a Deferred object and call any failCallbacks with the given args.

Deferred Object

deferred.rejectWith()

Reject a Deferred object and call any failCallbacks with the given context and args.

Deferred Object

deferred.resolve()

Resolve a Deferred object and call any doneCallbacks with the given args.

Deferred Object

deferred.resolveWith()

Resolve a Deferred object and call any doneCallbacks with the given context and args.

Deferred Object

deferred.state()

Determine the current state of a Deferred object.

Deferred Object

deferred.then()

Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

Deferred Object

jQuery.Deferred()

A factory function that returns a chainable utility object with methods to register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.

Core | Deferred Object

jQuery.when()

Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events.

Deferred Object

.promise()

Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.