<!DOCTYPE html><htmlclass="default"lang="en"data-base="../"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>PromiseBase | trilium</title><metaname="description"content="Documentation for trilium"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script><scriptasyncsrc="../assets/hierarchy.js"id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><ahref="../index.html"class="title">trilium</a><divid="tsd-toolbar-links"></div><buttonid="tsd-search-trigger"class="tsd-widget"aria-label="Search"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-search"></use></svg></button><dialogid="tsd-search"aria-label="Search"><inputrole="combobox"id="tsd-search-input"aria-controls="tsd-search-results"aria-autocomplete="list"aria-expanded="true"autocapitalize="off"autocomplete="off"placeholder="Search the docs"maxLength="100"/><ulrole="listbox"id="tsd-search-results"></ul><divid="tsd-search-status"aria-live="polite"aria-atomic="true"><div>Preparing search index...</div></div></dialog><ahref="#"class="tsd-widget menu"id="tsd-toolbar-menu-trigger"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"aria-label="Breadcrumb"><li><ahref="../modules/Frontend_Script_API.html">Frontend Script API</a></li><li><ahref="../modules/Frontend_Script_API._internal_.html"><internal></a></li><li><ahref=""aria-current="page">PromiseBase</a></li></ul><h1>Interface PromiseBase<TR, TJ, TN, UR, UJ, UN, VR, VJ, VN, SR, SJ, SN></h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>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.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">alwaysCallback</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>A function, or array of functions, that is called when the Deferred is resolved or rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">alwaysCallbacks</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-a-callback-for-both-success-and-error-using-the-deferredalways-method">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.<ahref="#example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-a-callback-for-both-success-and-error-using-the-deferredalways-method"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">get</span><spanclass="hl-1">( </span><spanclass="hl-3">"test.php"</span><spanclass="hl-1"> ).</span><spanclass="hl-0">always</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"$.get completed with success or error callback arguments"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">});</span>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-rejection-handlers-using-the-catch-method">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.<ahref="#example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-rejection-handlers-using-the-catch-method"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">get</span><spanclass="hl-1">( </span><spanclass="hl-3">"test.php"</span><spanclass="hl-1"> )</span><br/><spanclass="hl-1">.</span><spanclass="hl-0">then</span><spanclass="hl-1">( </span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"$.get succeeded"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">} )</span><br/><spanclass="hl-1">.</span><spanclass="hl-0">catch</span><spanclass="hl-1">( </span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"$.get failed!"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">} );</span>
</code><buttontype="button">Copy</button></pre>
</div></div><asideclass="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2650</li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-external"><h3class="tsd-anchor-link"id="done"><span>done</span><ahref="#done"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-external"><liclass="tsd-is-external"><divclass="tsd-signature tsd-anchor-link"id="done-1"><spanclass="tsd-kind-call-signature">done</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">doneCallback</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">doneCallbacks</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">this</span><ahref="#done-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object is resolved.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doneCallback</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>A function, or array of functions, that are called when the Deferred is resolved.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">doneCallbacks</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tr">TR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#ur">UR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vr">VR</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sr">SR</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-a-success-callback-using-the-done-method-javascript-get-testphp-donefunction--alert-get-succeeded----example--resolve-a-deferred-object-when-the-user-clicks-a-button-triggering-a-number-of-callback-functions">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.
```javascript
$.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:<ahref="#example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-a-success-callback-using-the-done-method-javascript-get-testphp-donefunction--alert-get-succeeded----example--resolve-a-deferred-object-when-the-user-clicks-a-button-triggering-a-number-of-callback-functions"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="html"><spanclass="hl-10"><!</span><spanclass="hl-11">doctype</span><spanclass="hl-1"></span><spanclass="hl-12">html</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">html</span><spanclass="hl-1"></span><spanclass="hl-12">lang</span><spanclass="hl-1">=</span><spanclass="hl-13">"en"</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">head</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">meta</span><spanclass="hl-1"></span><spanclass="hl-12">charset</span><spanclass="hl-1">=</span><spanclass="hl-13">"utf-8"</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">title</span><spanclass="hl-10">></span><spanclass="hl-1">deferred.done demo</span><spanclass="hl-10"></</span><spanclass="hl-11">title</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">script</span><spanclass="hl-15"></span><spanclass="hl-12">src</span><spanclass="hl-15">=</span><spanclass="hl-13">"https://code.jquery.com/jquery-3.3.1.js"</span><spanclass="hl-10">></</span><spanclass="hl-11">script</span><spanclass="hl-10">></span><br/><spanclass="hl-10"></</span><spanclass="hl-11">head</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">body</span><spanclass="hl-10">></span><br/><spanclass="hl-1"></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">button</span><spanclass="hl-10">></span><spanclass="hl-1">Go</span><spanclass="hl-10"></</span><spanclass="hl-11">button</span><spanclass="hl-10">></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">p</span><spanclass="hl-10">></span><spanclass="hl-1">Ready...</span><spanclass="hl-10"></</span><spanclass="hl-11">p</span><spanclass="hl-10">></span><br/><spanclass="hl-1"></span><br/><spanclass="hl-10"><</span><spanclass="hl-11">script</span><spanclass="hl-10">></span><br/><spanclass="hl-6">// 3 functions to call when the Deferred object is resolved</span><br/><spanclass="hl-2">function</span><spanclass="hl-15"></span><spanclass="hl-0">fn1</span><spanclass="hl-15">() {</span><br/><spanclass="hl-0">$</span><spanclass="hl-15">( </span><spanclass="hl-3">"p"</span><spanclass="hl-15"> ).</span><spanclass="hl-0">append</span><spanclass="hl-15">( </span><spanclass="hl-3">" 1 "</span><spanclass="hl-15"> );</span><br/><spanclass="hl-15">}</span><br/><spanclass="hl-2">function</span><spanclass="hl-15"></span><spanclass="hl-0">fn2</span><spanclass="hl-15">() {</span><br/><spanclass="hl-0">$</span><spanclass="hl-15">( </span><spanclass="hl-3">"p"</span><spanclass="hl-15"> ).</span><spanclass="hl-0">append</span><spanclass="hl-15">( </span><spanclass="hl-3">" 2 "</span><spanclass="hl-15"> );</span><br/><spanclass="hl-15">}</span><br/><spanclass="hl-2">function</span><spanclass="hl-15"></span><spanclass="hl-0">fn3</span><spanclass="hl-15">( </span><spanclass="hl-5">n</span><spanclass="hl-15"> ) {</span><br/><spanclass="hl-0">$</span><spanclass="hl-15">( </span><spanclass="hl-3">"p"</span><spanclass="hl-15"> ).</span><spanclass="hl-0">append</span><spanclass="hl-15">( </span><spanclass="hl-5">n</span><spanclass="hl-15"></span><spanclass="hl-1
</code><buttontype="button">Copy</button></pre>
</div></div><asideclass="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1303</li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-external"><h3class="tsd-anchor-link"id="fail"><span>fail</span><ahref="#fail"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-external"><liclass="tsd-is-external"><divclass="tsd-signature tsd-anchor-link"id="fail-1"><spanclass="tsd-kind-call-signature">fail</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">failCallback</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">failCallbacks</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">this</span><ahref="#fail-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object is rejected.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">failCallback</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>A function, or array of functions, that are called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">failCallbacks</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-you-can-attach-a-success-and-failure-callback-using-the-deferreddone-and-deferredfail-methods">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.<ahref="#example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-you-can-attach-a-success-and-failure-callback-using-the-deferreddone-and-deferredfail-methods"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">get</span><spanclass="hl-1">( </span><spanclass="hl-3">"test.php"</span><spanclass="hl-1"> )</span><br/><spanclass="hl-1">.</span><spanclass="hl-0">done</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"$.get succeeded"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">})</span><br/><spanclass="hl-1">.</span><spanclass="hl-0">fail</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"$.get failed!"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">});</span>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf">AJF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipearf">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanf">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebrf">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebjf">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebnf">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecrf">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecjf">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecnf">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperrf">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperjf">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipernf">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf">AJF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejec
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp">ANP</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipearp">ARP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajp">AJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp">ANP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebrp">BRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebjp">BJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebnp">BNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecrp">CRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecjp">CJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecnp">CNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperrp">RRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperjp">RJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipernp">RNP</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp">ANP</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifica
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated">Deprecated<ahref="#deprecated"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-1">Deprecated<ahref="#deprecated-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp-2">ANP</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipearp-2">ARP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajp-2">AJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp-2">ANP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebrp-2">BRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebjp-2">BJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebnp-2">BNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecrp-2">CRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecjp-2">CJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecnp-2">CNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperrp-2">RRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperjp-2">RJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipernp-2">RNP</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanp-2">ANP</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is c
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-2">Deprecated<ahref="#deprecated-2"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><spanid="pipearp-3"><spanclass="tsd-kind-type-parameter">ARP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipeajp-3"><spanclass="tsd-kind-type-parameter">AJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipeanp-3"><spanclass="tsd-kind-type-parameter">ANP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebrp-3"><spanclass="tsd-kind-type-parameter">BRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebjp-3"><spanclass="tsd-kind-type-parameter">BJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebnp-3"><spanclass="tsd-kind-type-parameter">BNP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecrp-3"><spanclass="tsd-kind-type-parameter">CRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecjp-3"><spanclass="tsd-kind-type-parameter">CJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecnp-3"><spanclass="tsd-kind-type-parameter">CNP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="piperrp-3"><spanclass="tsd-kind-type-parameter">RRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="piperjp-3"><spanclass="tsd-kind-type-parameter">RJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipernp-3"><spanclass="tsd-kind-type-parameter">RNP</span> = <spanclass="tsd-signature-type">never</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doneFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-3">Deprecated<ahref="#deprecated-3"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--chain-tasks-1">Example: ````Chain tasks:<ahref="#example--chain-tasks-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-2">var</span><spanclass="hl-1"></span><spanclass="hl-5">request</span><spanclass="hl-1"> = </span><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">ajax</span><spanclass="hl-1">( </span><spanclass="hl-5">url</span><spanclass="hl-1">, { </span><spanclass="hl-5">dataType:</span><spanclass="hl-1"></span><spanclass="hl-3">"json"</span><spanclass="hl-1"> } ),</span><br/><spanclass="hl-5">chained</span><spanclass="hl-1"> = </span><spanclass="hl-5">request</span><spanclass="hl-1">.</span><spanclass="hl-0">pipe</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">data</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-4">return</span><spanclass="hl-1"></span><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">ajax</span><spanclass="hl-1">( </span><spanclass="hl-5">url2</span><spanclass="hl-1">, { </span><spanclass="hl-5">data:</span><spanclass="hl-1"> { </span><spanclass="hl-5">user:</span><spanclass="hl-1"></span><spanclass="hl-5">data</span><spanclass="hl-1">.</span><spanclass="hl-5">userId</span><spanclass="hl-1"> } } );</span><br/><spanclass="hl-1">});</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-5">chained</span><spanclass="hl-1">.</span><spanclass="hl-0">done</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">data</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-6">// data retrieved from url2 as provided by the first request</span><br/><spanclass="hl-1">});</span>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-2">AJF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipearf-2">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-2">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanf-2">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebrf-2">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebjf-2">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebnf-2">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecrf-2">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecjf-2">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecnf-2">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperrf-2">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperjf-2">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipernf-2">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-2">AJF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is calle
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-4">Deprecated<ahref="#deprecated-4"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><spanid="pipearf-3"><spanclass="tsd-kind-type-parameter">ARF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipeajf-3"><spanclass="tsd-kind-type-parameter">AJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipeanf-3"><spanclass="tsd-kind-type-parameter">ANF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebrf-3"><spanclass="tsd-kind-type-parameter">BRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebjf-3"><spanclass="tsd-kind-type-parameter">BJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipebnf-3"><spanclass="tsd-kind-type-parameter">BNF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecrf-3"><spanclass="tsd-kind-type-parameter">CRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecjf-3"><spanclass="tsd-kind-type-parameter">CJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipecnf-3"><spanclass="tsd-kind-type-parameter">CNF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="piperrf-3"><spanclass="tsd-kind-type-parameter">RRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="piperjf-3"><spanclass="tsd-kind-type-parameter">RJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="pipernf-3"><spanclass="tsd-kind-type-parameter">RNF</span> = <spanclass="tsd-signature-type">never</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doneFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-3">AJF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipearf-3">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-3">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeanf-3">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebrf-3">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebjf-3">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipebnf-3">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecrf-3">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecjf-3">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipecnf-3">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperrf-3">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#piperjf-3">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipernf-3">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#pipeajf-3">AJF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is calle
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-5">Deprecated<ahref="#deprecated-5"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
</div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-6">Deprecated<ahref="#deprecated-6"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p> Deprecated since 1.8. Use <code><a href="#then" class="tsd-kind-method">then</a></code>.</p>
<p><strong>Cause</strong>: The <code>.pipe()</code> method on a <code>jQuery.Deferred</code> object was deprecated as of jQuery 1.8, when the <code>.then()</code> method was changed to perform the same function.</p>
<p><strong>Solution</strong>: In most cases it is sufficient to change all occurrences of <code>.pipe()</code> to <code>.then()</code>. Ensure that you aren't relying on context/state propagation (e.g., using <code>this</code>) or synchronous callback invocation, which were dropped from <code>.then()</code> for Promises/A+ interoperability as of jQuery 3.0.</p>
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
@example ````Chain tasks:<ahref="#example--filter-resolve-value-javascript-var-defer--deferred-filtered--deferpipefunction-value---return-value--2---deferresolve-5--filtereddonefunction-value---alert-value-is--25---10---value----example--chain-tasks-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-2">var</span><spanclass="hl-1"></span><spanclass="hl-5">request</span><spanclass="hl-1"> = </span><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">ajax</span><spanclass="hl-1">( </span><spanclass="hl-5">url</span><spanclass="hl-1">, { </span><spanclass="hl-5">dataType:</span><spanclass="hl-1"></span><spanclass="hl-3">"json"</span><spanclass="hl-1"> } ),</span><br/><spanclass="hl-5">chained</span><spanclass="hl-1"> = </span><spanclass="hl-5">request</span><spanclass="hl-1">.</span><spanclass="hl-0">pipe</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">data</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-4">return</span><spanclass="hl-1"></span><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">ajax</span><spanclass="hl-1">( </span><spanclass="hl-5">url2</span><spanclass="hl-1">, { </span><spanclass="hl-5">data:</span><spanclass="hl-1"> { </span><spanclass="hl-5">user:</span><spanclass="hl-1"></span><spanclass="hl-5">data</span><spanclass="hl-1">.</span><spanclass="hl-5">userId</span><spanclass="hl-1"> } } );</span><br/><spanclass="hl-1">});</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-5">chained</span><spanclass="hl-1">.</span><spanclass="hl-0">done</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">data</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-6">// data retrieved from url2 as provided by the first request</span><br/><spanclass="hl-1">});</span>
</code><buttontype="button">Copy</button></pre>
</div></div><asideclass="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1971</li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-external"><h3class="tsd-anchor-link"id="progress"><span>progress</span><ahref="#progress"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-external"><liclass="tsd-is-external"><divclass="tsd-signature tsd-anchor-link"id="progress-1"><spanclass="tsd-kind-call-signature">progress</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">progressCallback</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">progressCallbacks</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">this</span><ahref="#progress-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object generates progress notifications.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">progressCallback</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>A function, or array of functions, to be called when the Deferred generates progress notifications.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">progressCallbacks</span>: <ahref="../types/Frontend_Script_API._internal_.TypeOrArray.html"class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><spanclass="tsd-signature-symbol"><</span><ahref="../types/Frontend_Script_API._internal_.CallbackBase.html"class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, to be called when the Deferred generates
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><spanid="promisettarget"><spanclass="tsd-kind-type-parameter">TTarget</span><spanclass="tsd-signature-keyword">extends</span><spanclass="tsd-signature-type">object</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">target</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#promisettarget">TTarget</a></span><divclass="tsd-comment tsd-typography"><p>Object onto which the promise methods have to be attached</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="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-quotwinsquot-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-quotworkingquot-to-the-document-body">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 &quot;wins&quot; 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 &quot;working...&quot; to the document body.<ahref="#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-quotwinsquot-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-quotworkingquot-to-the-document-body"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-2">function</span><spanclass="hl-1"></span><spanclass="hl-0">asyncEvent</span><spanclass="hl-1">() {</span><br/><spanclass="hl-2">var</span><spanclass="hl-1"></span><spanclass="hl-5">dfd</span><spanclass="hl-1"> = </span><spanclass="hl-5">jQuery</span><spanclass="hl-1">.</span><spanclass="hl-0">Deferred</span><spanclass="hl-1">();</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Resolve after a random interval</span><br/><spanclass="hl-0">setTimeout</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-5">dfd</span><spanclass="hl-1">.</span><spanclass="hl-0">resolve</span><spanclass="hl-1">( </span><spanclass="hl-3">"hurray"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">}, </span><spanclass="hl-5">Math</span><spanclass="hl-1">.</span><spanclass="hl-0">floor</span><spanclass="hl-1">( </span><spanclass="hl-9">400</span><spanclass="hl-1"> + </span><spanclass="hl-5">Math</span><spanclass="hl-1">.</span><spanclass="hl-0">random</span><spanclass="hl-1">() * </span><spanclass="hl-9">2000</span><spanclass="hl-1"> ) );</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Reject after a random interval</span><br/><spanclass="hl-0">setTimeout</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">() {</span><br/><spanclass="hl-5">dfd</span><spanclass="hl-1">.</span><spanclass="hl-0">reject</span><spanclass="hl-1">( </span><spanclass="hl-3">"sorry"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">}, </span><spanclass="hl-5">Math</span><spanclass="hl-1">.</span><spanclass="hl-0">floor</span><spanclass="hl-1">( </span><spanclass="hl-9">400</span><spanclass="hl-1"> + </span><spanclass="hl-5">Math</span><spanclass="hl-1">.</span><spanclass="hl-0">random</span><spanclass="hl-1">() * </span><spanclass="hl-9">2000</span><spanclass="hl-1"> ) );</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Show a "working..." message every half-second</span><br/><spanclass="hl-0">setTimeout</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1"></span><spanclass="hl-0">working</span><spanclass="hl-1">() {</span><br/><spanclass="hl-4">if</span><spanclass="hl-1"> ( </span><spanclass="hl-5">dfd</span
</code><buttontype="button">Copy</button></pre>
</div></div><asideclass="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1386</li></ul></aside></div></li><liclass="tsd-is-external"><divclass="tsd-signature tsd-anchor-link"id="promise-2"><spanclass="tsd-kind-call-signature">promise</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">this</span><ahref="#promise-2"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return a Deferred's Promise object.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--use-the-target-argument-to-promote-an-existing-object-to-a-promise">Example: ````Use the target argument to promote an existing object to a Promise:<ahref="#example--use-the-target-argument-to-promote-an-existing-object-to-a-promise"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><codeclass="javascript"><spanclass="hl-6">// Existing object</span><br/><spanclass="hl-2">var</span><spanclass="hl-1"></span><spanclass="hl-5">obj</span><spanclass="hl-1"> = {</span><br/><spanclass="hl-0">hello</span><spanclass="hl-5">:</span><spanclass="hl-1"></span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">name</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-0">alert</span><spanclass="hl-1">( </span><spanclass="hl-3">"Hello "</span><spanclass="hl-1"> + </span><spanclass="hl-5">name</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1">}</span><br/><spanclass="hl-1">},</span><br/><spanclass="hl-6">// Create a Deferred</span><br/><spanclass="hl-5">defer</span><spanclass="hl-1"> = </span><spanclass="hl-5">$</span><spanclass="hl-1">.</span><spanclass="hl-0">Deferred</span><spanclass="hl-1">();</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Set object as a promise</span><br/><spanclass="hl-5">defer</span><spanclass="hl-1">.</span><spanclass="hl-0">promise</span><spanclass="hl-1">( </span><spanclass="hl-5">obj</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Resolve the deferred</span><br/><spanclass="hl-5">defer</span><spanclass="hl-1">.</span><spanclass="hl-0">resolve</span><spanclass="hl-1">( </span><spanclass="hl-3">"John"</span><spanclass="hl-1"> );</span><br/><spanclass="hl-1"></span><br/><spanclass="hl-6">// Use the object as a Promise</span><br/><spanclass="hl-5">obj</span><spanclass="hl-1">.</span><spanclass="hl-0">done</span><spanclass="hl-1">(</span><spanclass="hl-2">function</span><spanclass="hl-1">( </span><spanclass="hl-5">name</span><spanclass="hl-1"> ) {</span><br/><spanclass="hl-5">obj</span><spanclass="hl-1">.</span><spanclass="hl-0">hello</span><spanclass="hl-1">( </span><spanclass="hl-5">name</span><spanclass="hl-1"> ); </span><spanclass="hl-6">// Will alert "Hello John"</span><br/><spanclass="hl-1">}).</span><spanclass="hl-0">hello</span><spanclass="hl-1">( </span><spanclass="hl-3">"Karl"</span><spanclass="hl-1"> ); </span><spanclass="hl-6">// Will alert "Hello Karl"</span>
</code><buttontype="button">Copy</button></pre>
</div></div><asideclass="tsd-sources"><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1414</li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-external"><h3class="tsd-anchor-link"id="state"><span>state</span><ahref="#state"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-external"><liclass="tsd-is-external"><divclass="tsd-signature tsd-anchor-link"id="state-1"><spanclass="tsd-kind-call-signature">state</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">"pending"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"resolved"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"rejected"</span><ahref="#state-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Determine the current state of a Deferred object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf">ARF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenajf">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanf">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbrf">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbjf">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbnf">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencrf">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencjf">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencnf">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrrf">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrjf">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrnf">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf">ARF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejec
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp">ANP</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarp">ARP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenajp">AJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp">ANP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbrp">BRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbjp">BJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbnp">BNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencrp">CRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencjp">CJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencnp">CNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrrp">RRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrjp">RJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrnp">RNP</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp">ANP</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifica
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-handlers-using-the-then-method-javascript-get-testphp-then-function--alert-get-succeeded---function--alert-get-failed-----example--filter-the-resolve-value">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.
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tn">TN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#un">UN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vn">VN</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sn">SN</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp-2">ANP</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarp-2">ARP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenajp-2">AJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp-2">ANP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbrp-2">BRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbjp-2">BJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbnp-2">BNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencrp-2">CRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencjp-2">CJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencnp-2">CNP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrrp-2">RRP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrjp-2">RJP</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrnp-2">RNP</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanp-2">ANP</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is c
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><spanid="thenarp-3"><spanclass="tsd-kind-type-parameter">ARP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenajp-3"><spanclass="tsd-kind-type-parameter">AJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenanp-3"><spanclass="tsd-kind-type-parameter">ANP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbrp-3"><spanclass="tsd-kind-type-parameter">BRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbjp-3"><spanclass="tsd-kind-type-parameter">BJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbnp-3"><spanclass="tsd-kind-type-parameter">BNP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencrp-3"><spanclass="tsd-kind-type-parameter">CRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencjp-3"><spanclass="tsd-kind-type-parameter">CJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencnp-3"><spanclass="tsd-kind-type-parameter">CNP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrrp-3"><spanclass="tsd-kind-type-parameter">RRP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrjp-3"><spanclass="tsd-kind-type-parameter">RJP</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrnp-3"><spanclass="tsd-kind-type-parameter">RNP</span> = <spanclass="tsd-signature-type">never</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doneFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-2">ARF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-2">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenajf-2">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanf-2">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbrf-2">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbjf-2">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbnf-2">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencrf-2">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencjf-2">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencnf-2">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrrf-2">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrjf-2">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrnf-2">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-2">ARF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is calle
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
</div><divclass="tsd-tag-example"><h4class="tsd-anchor-link"id="example--since-the-jqueryget-method-returns-a-jqxhr-object-which-is-derived-from-a-deferred-object-we-can-attach-handlers-using-the-then-method-javascript-get-testphp-then-function--alert-get-succeeded---function--alert-get-failed-----example--filter-the-resolve-value-1">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.
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><spanid="thenarf-3"><spanclass="tsd-kind-type-parameter">ARF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenajf-3"><spanclass="tsd-kind-type-parameter">AJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenanf-3"><spanclass="tsd-kind-type-parameter">ANF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbrf-3"><spanclass="tsd-kind-type-parameter">BRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbjf-3"><spanclass="tsd-kind-type-parameter">BJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenbnf-3"><spanclass="tsd-kind-type-parameter">BNF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencrf-3"><spanclass="tsd-kind-type-parameter">CRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencjf-3"><spanclass="tsd-kind-type-parameter">CJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thencnf-3"><spanclass="tsd-kind-type-parameter">CNF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrrf-3"><spanclass="tsd-kind-type-parameter">RRF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrjf-3"><spanclass="tsd-kind-type-parameter">RJF</span> = <spanclass="tsd-signature-type">never</span></span></li><li><spanid="thenrnf-3"><spanclass="tsd-kind-type-parameter">RNF</span> = <spanclass="tsd-signature-type">never</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doneFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#tj">TJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">u</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#uj">UJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">v</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#vj">VJ</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">s</span><spanclass="tsd-signature-symbol">:</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="#sj">SJ</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><br/><spanclass="tsd-signature-symbol">|</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-3">ARF</a><br/><spanclass="tsd-signature-symbol">|</span><ahref=""class="tsd-signature-type tsd-kind-interface">PromiseBase</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-3">ARF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenajf-3">AJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenanf-3">ANF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbrf-3">BRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbjf-3">BJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenbnf-3">BNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencrf-3">CRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencjf-3">CJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thencnf-3">CNF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrrf-3">RRF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrjf-3">RJF</a><spanclass="tsd-signature-symbol">,</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenrnf-3">RNF</a><spanclass="tsd-signature-symbol">></span><br/><spanclass="tsd-signature-symbol">|</span><ahref="Frontend_Script_API._internal_.Thenable.html"class="tsd-signature-type tsd-kind-interface">Thenable</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="Frontend_Script_API._internal_.JQueryPromise.html#thenarf-3">ARF</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is calle
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">failFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">progressFilter</span>: <spanclass="tsd-signature-type">null</span></span><divclass="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
