PromiseBase | FORMCYCLE 6.6.11 - JavaScript for forms

This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.

see: http://api.jquery.com/Types/#Promise
deprecated: Experimental. Avoid referncing this type directly in your code.

Type parameters

Hierarchy

Promise<TR>
PromiseLike<TR>
- PromiseBase

Index

Properties

Methods

Properties

Promise

Promise: PromiseConstructor

__@toStringTag

__@toStringTag: string

Methods

always

always(alwaysCallback: TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>, ...alwaysCallbacks: Array<TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>>): this

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

see

https://api.jquery.com/deferred.always/

since

1.6

Parameters
- alwaysCallback: TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>
  
  A function, or array of functions, that is called when the Deferred is resolved or rejected.
- Rest ...alwaysCallbacks: Array<TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>>
  
  Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.
Returns this

catch

catch<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>(failFilter?: function | null): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

Overrides Promise.catch

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

see

https://api.jquery.com/deferred.catch/

since

3.0

Type parameters
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
Parameters
- Optional failFilter: function | null
  
  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<TR, UR, VR, SR>>, ...doneCallbacks: Array<TypeOrArray<CallbackBase<TR, UR, VR, SR>>>): this

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

see

https://api.jquery.com/deferred.done/

since

1.5

Parameters
- doneCallback: TypeOrArray<CallbackBase<TR, UR, VR, SR>>
  
  A function, or array of functions, that are called when the Deferred is resolved.
- Rest ...doneCallbacks: Array<TypeOrArray<CallbackBase<TR, UR, VR, SR>>>
  
  Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.
Returns this

fail

fail(failCallback: TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>, ...failCallbacks: Array<TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>>): this

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

see

https://api.jquery.com/deferred.fail/

since

1.5

Parameters
- failCallback: TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>
  
  A function, or array of functions, that are called when the Deferred is rejected.
- Rest ...failCallbacks: Array<TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>>
  
  Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
Returns this

finally

finally(onfinally?: function | undefined | null): Promise<TR>

Inherited from Promise.finally

Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters
- Optional onfinally: function | undefined | null
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<TR>

A Promise for the completion of the callback.

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: function, failFilter: function, progressFilter: function): 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: function, progressFilter: function): 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: function, failFilter: null, progressFilter: function): 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?: function): 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: function, failFilter: function, 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: function, 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: function, failFilter?: null, progressFilter?: null): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- 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
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
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: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | 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>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | AJF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<AJF> | 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>
Utility method to filter and/or chain Deferreds.

see

https://api.jquery.com/deferred.pipe/

since

1.6

since

1.7

deprecated

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | 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<TN, UN, VN, SN>>, ...progressCallbacks: Array<TypeOrArray<CallbackBase<TN, UN, VN, SN>>>): this

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

see

https://api.jquery.com/deferred.progress/

since

1.7

Parameters
- progressCallback: TypeOrArray<CallbackBase<TN, UN, VN, SN>>
  
  A function, or array of functions, to be called when the Deferred generates progress notifications.
- Rest ...progressCallbacks: Array<TypeOrArray<CallbackBase<TN, UN, VN, SN>>>
  
  Optional additional functions, or arrays of functions, to be called when the Deferred generates progress notifications.
Returns this

promise

promise<TTarget>(target: TTarget): this & TTarget
promise(): this

Return a Deferred's Promise object.

see

https://api.jquery.com/deferred.promise/

since

1.5

Type parameters
- TTarget: object
Parameters
- target: TTarget
  
  Object onto which the promise methods have to be attached
Returns this & TTarget
Return a Deferred's Promise object.

see

https://api.jquery.com/deferred.promise/

since

1.5

Returns this

state

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

Determine the current state of a Deferred object.

see

https://api.jquery.com/deferred.state/

since

1.7

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

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: function, failFilter: function, progressFilter: function): 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: function, progressFilter: function): 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: function, failFilter: null, progressFilter: function): 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?: function): 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: function, failFilter: function, 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: function, 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: function, failFilter?: null, progressFilter?: null): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- 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
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: null
  
  An optional function that is called when the Deferred is rejected.
- progressFilter: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | 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>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARP
- AJP
- ANP
- BRP
- BJP
- BNP
- CRP
- CJP
- CNP
- RRP
- RJP
- RNP
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: function
  
  An optional function that is called when progress notifications are sent to the Deferred.
  - - (t: TN, u: UN, v: VN, ...s: SN[]): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
    - Parameters
      - t: TN
      - u: UN
      - v: VN
      - Rest ...s: SN[]
      Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP> | Thenable<ANP> | ANP
Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | 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>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARF
- AJF
- ANF
- BRF
- BJF
- BNF
- CRF
- CJF
- CNF
- RRF
- RJF
- RNF
Parameters
- doneFilter: null
  
  An optional function that is called when the Deferred is resolved.
- failFilter: function
  
  An optional function that is called when the Deferred is rejected.
  - - (t: TJ, u: UJ, v: VJ, ...s: SJ[]): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | ARF
    - Parameters
      - t: TJ
      - u: UJ
      - v: VJ
      - Rest ...s: SJ[]
      Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF> | Thenable<ARF> | 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>
Overrides Promise.then

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

see

https://api.jquery.com/deferred.then/

since

1.8

Type parameters
- ARD
- AJD
- AND
- BRD
- BJD
- BND
- CRD
- CJD
- CND
- RRD
- RJD
- RND
Parameters
- doneFilter: function
  
  An optional function that is called when the Deferred is resolved.
  - - (t: TR, u: UR, v: VR, ...s: SR[]): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | ARD
    - Parameters
      - t: TR
      - u: UR
      - v: VR
      - Rest ...s: SR[]
      Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND> | Thenable<ARD> | 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

TR

TJ

TN

UR

UJ

UN

VR

VJ

VN

SR

SJ

SN

Hierarchy

Index

Properties

Methods

Properties

Promise

__@toStringTag

Methods

always

Parameters

alwaysCallback: TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>

Rest ...alwaysCallbacks: Array<TypeOrArray<CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>>

Returns this

catch

Type parameters

ARF

AJF

ANF

BRF

BJF

BNF

CRF

CJF

CNF

RRF

RJF

RNF

Parameters

Optional failFilter: function | null

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

done

Parameters

doneCallback: TypeOrArray<CallbackBase<TR, UR, VR, SR>>

Rest ...doneCallbacks: Array<TypeOrArray<CallbackBase<TR, UR, VR, SR>>>

Returns this

fail

Parameters

failCallback: TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>

Rest ...failCallbacks: Array<TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>>

Returns this

finally

Parameters

Optional onfinally: function | undefined | null

Returns Promise<TR>

pipe

Type parameters

ARD

AJD

AND

BRD

BJD

BND

CRD

CJD

CND

RRD

RJD

RND

ARF

AJF

ANF

BRF

BJF

BNF

CRF

CJF

CNF