pfXHR | PrimeFaces JavaScript API Docs

The XHR request object used by PrimeFaces. It extends the jqXHR object as used by JQuery, but adds additional properties specific to PrimeFaces.

Type Parameters

P extends PrimeFacesArgs = PrimeFacesArgs

Data made available by the server via pfXHR.pfArgs.

Hierarchy

jqXHR
- pfXHR

Properties

Optional pfArgs

pfArgs?: P

An object with additional values added by PrimeFaces. For example, when you call PrimeFaces.current().ajax().addCallbackParam(...) on the server in a bean method, the added parameters are available in this object. This is also how you can access pass values from the server to the client after calling a remote command. See PrimeFaces.ajax.pfXHR and PrimeFaces.ab.

Optional pfSettings

pfSettings?: PrimeFacesSettings

Additional settings, such as portlet forms and nonces.

Readonly readyState

readyState: number

Returns client's state.

Optional responseJSON

responseJSON?: any

Readonly responseText

responseText: string

Returns response as text.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".

Optional Readonly responseXML

responseXML?: null | Document

Returns the response as document.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".

Readonly status

status: number

Readonly statusText

statusText: string

Methods

abort

abort(statusText?: string): void

Inherited from jqXHR.abort
Parameters
- Optional statusText: string
Returns void

always

always(alwaysCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>, ...alwaysCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>[]): pfXHR<P>

Inherited from jqXHR.always
Add handlers to be called when the Deferred object is either resolved or rejected.
see
``

since
1.6

example
````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.
```
$.get( "test.php" ).always(function() {
alert( "$.get completed with success or error callback arguments" );
});
```
Parameters
- alwaysCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>
  
  A function, or array of functions, that is called when the Deferred is resolved or rejected.
- Rest ...alwaysCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>[]
  
  Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.
Returns pfXHR<P>

catch

catch<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(failFilter?: null | ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

Inherited from jqXHR.catch
Add handlers to be called when the Deferred object is rejected.
see
``

since
3.0

example
````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.
```
$.get( "test.php" )
.then( function() {
alert( "$.get succeeded" );
} )
.catch( function() {
alert( "$.get failed!" );
} );
```
Type Parameters
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
Parameters
- Optional failFilter: null | ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)
  
  A function that is called when the Deferred is rejected.
Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

done

done(doneCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>, ...doneCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>[]): pfXHR<P>

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

see

since

1.5

example

````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method.

$.get( "test.php" ).done(function() {
alert( "$.get succeeded" );
});

example

````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.done demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<button>Go</button>
<p>Ready...</p>

<script>
// 3 functions to call when the Deferred object is resolved
function fn1() {
$( "p" ).append( " 1 " );
}
function fn2() {
$( "p" ).append( " 2 " );
}
function fn3( n ) {
$( "p" ).append( n + " 3 " + n );
}

// Create a deferred object
var dfd = $.Deferred();

// Add handlers to be called when dfd is resolved
dfd
// .done() can take any number of functions or arrays of functions
.done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
// We can chain done methods, too
.done(function( n ) {
$( "p" ).append( n + " we're done." );
});

// Resolve the Deferred object when the button is clicked
$( "button" ).on( "click", function() {
dfd.resolve( "and" );
});
</script>

</body>
</html>

Parameters

doneCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>

A function, or array of functions, that are called when the Deferred is resolved.
Rest ...doneCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>[]

Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.

Returns pfXHR<P>

fail

fail(failCallback: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>, ...failCallbacks: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>[]): pfXHR<P>

Inherited from jqXHR.fail
Add handlers to be called when the Deferred object is rejected.
see
``

since
1.5

example
````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.
```
$.get( "test.php" )
.done(function() {
alert( "$.get succeeded" );
})
.fail(function() {
alert( "$.get failed!" );
});
```
Parameters
- failCallback: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>
  
  A function, or array of functions, that are called when the Deferred is rejected.
- Rest ...failCallbacks: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>[]
  
  Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
Returns pfXHR<P>

getAllResponseHeaders

getAllResponseHeaders(): string

Inherited from jqXHR.getAllResponseHeaders
Returns string

getResponseHeader

getResponseHeader(name: string): null | string

Inherited from jqXHR.getResponseHeader
Parameters
- name: string
Returns null | string

overrideMimeType

overrideMimeType(mime: string): void

Inherited from jqXHR.overrideMimeType

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

Throws an "InvalidStateError" DOMException if state is loading or done.

Parameters
- mime: string
Returns void

pipe

pipe<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>), progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP, BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP, CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP, RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>
pipe<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: null, failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>), progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP, BRF | BRP, BJF | BJP, BNF | BNP, CRF | CRP, CJF | CJP, CNF | CNP, RRF | RRP, RJF | RJP, RNF | RNP>
pipe<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: null, progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP, BRD | BRP, BJD | BJP, BND | BNP, CRD | CRP, CJD | CJP, CND | CNP, RRD | RRP, RJD | RJP, RND | RNP>
pipe<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: null, failFilter: null, progressFilter?: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
pipe<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>), progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF, BRD | BRF, BJD | BJF, BND | BNF, CRD | CRF, CJD | CJF, CND | CNF, RRD | RRF, RJD | RJF, RND | RNF>
pipe<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(doneFilter: null, failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>), progressFilter?: null): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
pipe<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter?: null, progressFilter?: null): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter resolve value:
```
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP, BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP, CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP, RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP, BRF | BRP, BJF | BJP, BNF | BNP, CRF | CRP, CJF | CJP, CNF | CNP, RRF | RRP, RJF | RJP, RNF | RNP>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter resolve value:
```
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARD | ARP, AJD | AJP, AND | ANP, BRD | BRP, BJD | BJP, BND | BNP, CRD | CRP, CJD | CJP, CND | CNP, RRD | RRP, RJD | RJP, RND | RNP>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- Optional progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter resolve value:
```
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARD | ARF, AJD | AJF, AND | ANF, BRD | BRF, BJD | BJF, BND | BNF, CRD | CRF, CJD | CJF, CND | CNF, RRD | RRF, RJD | RJF, RND | RNF>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns AJF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF>
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
Inherited from jqXHR.pipe
Utility method to filter and/or chain Deferreds.
see
``

since
1.6

since
1.7

deprecated
Deprecated since 1.8. Use ``.

Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

example
````Filter resolve value:
```
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- Optional failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

progress

progress(progressCallback: TypeOrArray<CallbackBase<never, never, never, never>>, ...progressCallbacks: TypeOrArray<CallbackBase<never, never, never, never>>[]): pfXHR<P>

Inherited from jqXHR.progress

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

see
``

since
1.7

Parameters
- progressCallback: TypeOrArray<CallbackBase<never, never, never, never>>
  
  A function, or array of functions, to be called when the Deferred generates progress notifications.
- Rest ...progressCallbacks: TypeOrArray<CallbackBase<never, never, never, never>>[]
  
  Optional additional functions, or arrays of functions, to be called when the Deferred generates progress notifications.
Returns pfXHR<P>

promise

promise<TTarget>(target: TTarget): pfXHR<P> & TTarget
promise(): pfXHR<P>

Return a Deferred's Promise object.

see

since

1.5

example

````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first "wins" and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds "working..." to the document body.

function asyncEvent() {
var dfd = jQuery.Deferred();

// Resolve after a random interval
setTimeout(function() {
dfd.resolve( "hurray" );
}, Math.floor( 400 + Math.random() * 2000 ) );

// Reject after a random interval
setTimeout(function() {
dfd.reject( "sorry" );
}, Math.floor( 400 + Math.random() * 2000 ) );

// Show a "working..." message every half-second
setTimeout(function working() {
if ( dfd.state() === "pending" ) {
dfd.notify( "working... " );
setTimeout( working, 500 );
}
}, 1 );

// Return the Promise so caller can't change the Deferred
return dfd.promise();
}

// Attach a done, fail, and progress handler for the asyncEvent
$.when( asyncEvent() ).then(
function( status ) {
alert( status + ", things are going well" );
},
function( status ) {
alert( status + ", you fail this time" );
},
function( status ) {
$( "body" ).append( status );
}
);

Type Parameters

TTarget extends object

Parameters

target: TTarget

Object onto which the promise methods have to be attached

Returns pfXHR<P> & TTarget

Return a Deferred's Promise object.

see

since

1.5

example

````Use the target argument to promote an existing object to a Promise:

// Existing object
var obj = {
hello: function( name ) {
alert( "Hello " + name );
}
},
// Create a Deferred
defer = $.Deferred();

// Set object as a promise
defer.promise( obj );

// Resolve the deferred
defer.resolve( "John" );

// Use the object as a Promise
obj.done(function( name ) {
obj.hello( name ); // Will alert "Hello John"
}).hello( "Karl" ); // Will alert "Hello Karl"

Returns pfXHR<P>

setRequestHeader

setRequestHeader(name: string, value: string): void

Inherited from jqXHR.setRequestHeader

Combines a header in author request headers.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

Throws a "SyntaxError" DOMException if name is not a header name or if value is not a header value.

Parameters
- name: string
- value: string
Returns void

state

state(): "pending" | "resolved" | "rejected"

Inherited from jqXHR.state

Determine the current state of a Deferred object.

see
``

since
1.7

Returns "pending" | "resolved" | "rejected"

statusCode

statusCode(map: StatusCodeCallbacks<any>): void

Inherited from jqXHR.statusCode
Parameters
- map: StatusCodeCallbacks<any>
Returns void

then

then<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>), progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP, BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP, CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP, RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>
then<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: null, failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>), progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP, BRF | BRP, BJF | BJP, BNF | BNP, CRF | CRP, CJF | CJP, CNF | CNP, RRF | RRP, RJF | RJP, RNF | RNP>
then<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: null, progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP, BRD | BRP, BJD | BJP, BND | BNP, CRD | CRP, CJD | CJP, CND | CNP, RRD | RRP, RJD | RJP, RND | RNP>
then<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>(doneFilter: null, failFilter: null, progressFilter?: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
then<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND, ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>), progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF, BRD | BRF, BJD | BJF, BND | BNF, CRD | CRF, CJD | CJF, CND | CNF, RRD | RRF, RJD | RJF, RND | RNF>
then<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(doneFilter: null, failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>), progressFilter?: null): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
then<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>(doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>), failFilter?: null, progressFilter?: null): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
example
````Filter the resolve value:
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<button>Filter Resolve</button>
<p></p>

<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};

$( "button" ).on( "click", filterResolve );
</script>

</body>
</html>
```
example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP, BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP, CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP, RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP, BRF | BRP, BJF | BJP, BNF | BNP, CRF | CRP, CJF | CJP, CNF | CNP, RRF | RRP, RJF | RJP, RNF | RNP>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Filter the resolve value:
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<button>Filter Resolve</button>
<p></p>

<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};

$( "button" ).on( "click", filterResolve );
</script>

</body>
</html>
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARD | ARP, AJD | AJP, AND | ANP, BRD | BRP, BJD | BJP, BND | BNP, CRD | CRP, CJD | CJP, CND | CNP, RRD | RRP, RJD | RJP, RND | RNP>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARP = never
- AJP = never
- ANP = never
- BRP = never
- BJP = never
- BNP = never
- CRP = never
- CJP = never
- CNP = never
- RRP = never
- RJP = never
- RNP = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- Optional progressFilter: ((t: never, u: never, v: never, ...s: never[]) => ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>)
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: never, u: never, v: never, ...s: never[]): ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
    - Parameters
      - t: never
      - u: never
      - v: never
      - Rest ...s: never[]
      Returns ANP | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP>
Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
example
````Filter the resolve value:
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<button>Filter Resolve</button>
<p></p>

<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};

$( "button" ).on( "click", filterResolve );
</script>

</body>
</html>
```
example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARD | ARF, AJD | AJF, AND | ANF, BRD | BRF, BJD | BJF, BND | BNF, CRD | CRF, CJD | CJF, CND | CNF, RRD | RRF, RJD | RJF, RND | RNF>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Filter reject value:
```
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});

defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARF = never
- AJF = never
- ANF = never
- BRF = never
- BJF = never
- BNF = never
- CRF = never
- CJF = never
- CNF = never
- RRF = never
- RJF = never
- RNF = never
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)
  
  An optional function that is called when the Deferred is rejected.
  - - (t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]): ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
    - Parameters
      - t: jqXHR<any>
      - u: ErrorTextStatus
      - v: string
      - Rest ...s: never[]
      Returns ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
Inherited from jqXHR.then
Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
see
``

since
1.8

example
````Filter the resolve value:
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<button>Filter Resolve</button>
<p></p>

<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});

defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};

$( "button" ).on( "click", filterResolve );
</script>

</body>
</html>
```
example
````Chain tasks:
```
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});

chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
Type Parameters
- ARD = never
- AJD = never
- AND = never
- BRD = never
- BJD = never
- BND = never
- CRD = never
- CJD = never
- CND = never
- RRD = never
- RJD = never
- RND = never
Parameters
- doneFilter: ((t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]) => ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>)
  
  An optional function that is called when the Deferred is resolved.
  - - (t: any, u: SuccessTextStatus, v: jqXHR<any>, ...s: never[]): ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
    - Parameters
      - t: any
      - u: SuccessTextStatus
      - v: jqXHR<any>
      - Rest ...s: never[]
      Returns ARD | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD>
- Optional failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- Optional progressFilter: null
  
  An optional function that is called when progress notifications are sent to the Deferred.
Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

Type Parameters

P extends PrimeFacesArgs = PrimeFacesArgs

Hierarchy

Index

Properties

Methods

Properties

Optional pfArgs

Optional pfSettings

Readonly readyState

Optional responseJSON

Readonly responseText

Optional Readonly responseXML

Readonly status

Readonly statusText

Methods

abort

Parameters

Optional statusText: string

Returns void

always

Parameters

alwaysCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>

Rest ...alwaysCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus | ErrorTextStatus, string | jqXHR<any>, never>>[]

Returns pfXHR<P>

catch

Type Parameters

ARF = never

AJF = never

ANF = never

BRF = never

BJF = never

BNF = never

CRF = never

CJF = never

CNF = never

RRF = never

RJF = never

RNF = never

Parameters

Optional failFilter: null | ((t: jqXHR<any>, u: ErrorTextStatus, v: string, ...s: never[]) => ARF | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF>)

Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

done

Parameters

doneCallback: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>

Rest ...doneCallbacks: TypeOrArray<CallbackBase<any, SuccessTextStatus, jqXHR<any>, never>>[]

Returns pfXHR<P>

fail

Parameters

failCallback: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>

Rest ...failCallbacks: TypeOrArray<CallbackBase<jqXHR<any>, ErrorTextStatus, string, never>>[]

Returns pfXHR<P>

getAllResponseHeaders

Returns string

getResponseHeader

Parameters

name: string

Returns null | string

overrideMimeType

Parameters

mime: string

Returns void

pipe

Type Parameters

ARD = never

AJD = never

AND = never

BRD = never

BJD = never

BND = never

CRD = never

CJD = never

CND = never

RRD = never

RJD = never

RND = never

ARF = never

AJF = never

ANF = never

BRF = never