mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-28 02:22:26 +08:00
444 lines
732 KiB
HTML
444 lines
732 KiB
HTML
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JQueryPromise | trilium</title><meta name="description" content="Documentation for trilium"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../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><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">trilium</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Frontend_Script_API.html">Frontend Script API</a></li><li><a href="../modules/Frontend_Script_API._internal_.html"><internal></a></li><li><a href="" aria-current="page">JQueryPromise</a></li></ul><h1>Interface JQueryPromise<T></h1></div><section class="tsd-panel tsd-comment"><div class="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><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/Types/#Promise">https://api.jquery.com/Types/#Promise</a></code></p>
|
|||
|
|
</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JQueryPromise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#always-1">always</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">alwaysCallback</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">alwaysCallbacks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#catch-1">catch</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catcharf">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchajf">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchanf">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbrf">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbjf">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbnf">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/>
|
|||
|
|
<a href="#catch" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>catch</span></a>
|
|||
|
|
<a href="#done" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>done</span></a>
|
|||
|
|
<a href="#fail" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail</span></a>
|
|||
|
|
<a href="#pipe" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pipe</span></a>
|
|||
|
|
<a href="#progress" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>progress</span></a>
|
|||
|
|
<a href="#promise" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>promise</span></a>
|
|||
|
|
<a href="#state" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state</span></a>
|
|||
|
|
<a href="#then" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>then</span></a>
|
|||
|
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="always"><span>always</span><a href="#always" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="always-1"><span class="tsd-kind-call-signature">always</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">alwaysCallback</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">alwaysCallbacks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#always-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object is either resolved or rejected.</p>
|
|||
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">alwaysCallback</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A function, or array of functions, that is called when the Deferred is resolved or rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">alwaysCallbacks</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.always/">https://api.jquery.com/deferred.always/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since">Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">( </span><span class="hl-3">"test.php"</span><span class="hl-1"> ).</span><span class="hl-0">always</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"$.get completed with success or error callback arguments"</span><span class="hl-1"> );</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#always">always</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1239</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="catch"><span>catch</span><a href="#catch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="catch-1"><span class="tsd-kind-call-signature">catch</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catcharf">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchajf">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchanf">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbrf">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbjf">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbnf">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcrf">CRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcjf">CJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcnf">CNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrrf">RRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrjf">RJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrnf">RNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">failFilter</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-sign
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="catcharf"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchajf"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchanf"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchbrf"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchbjf"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchbnf"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchcrf"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchcjf"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchcnf"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchrrf"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchrjf"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="catchrnf"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">failFilter</span>: <br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catcharf">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#catcharf">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchajf">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchanf">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbrf">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbjf">BJF</a><span class="tsd-s
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#catcharf">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchajf">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchanf">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbrf">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbjf">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchbnf">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcrf">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcjf">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchcnf">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrrf">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrjf">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#catchrnf">RNF</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-2">See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.catch/">https://api.jquery.com/deferred.catch/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-1">Since<a href="#since-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>3.0</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">( </span><span class="hl-3">"test.php"</span><span class="hl-1"> )</span><br/><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">( </span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"$.get succeeded"</span><span class="hl-1"> );</span><br/><span class="hl-1">} )</span><br/><span class="hl-1">.</span><span class="hl-0">catch</span><span class="hl-1">( </span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"$.get failed!"</span><span class="hl-1"> );</span><br/><span class="hl-1">} );</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#catch">catch</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2650</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="done"><span>done</span><a href="#done" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="done-1"><span class="tsd-kind-call-signature">done</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneCallback</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">doneCallbacks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#done-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object is resolved.</p>
|
|||
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneCallback</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A function, or array of functions, that are called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">doneCallbacks</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-3">See<a href="#see-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.done/">https://api.jquery.com/deferred.done/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-2">Since<a href="#since-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.5</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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:<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10"><!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">"en"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">"utf-8"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">title</span><span class="hl-10">></span><span class="hl-1">deferred.done demo</span><span class="hl-10"></</span><span class="hl-11">title</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">"https://code.jquery.com/jquery-3.3.1.js"</span><span class="hl-10">></</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-10"></</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">body</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">button</span><span class="hl-10">></span><span class="hl-1">Go</span><span class="hl-10"></</span><span class="hl-11">button</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">p</span><span class="hl-10">></span><span class="hl-1">Ready...</span><span class="hl-10"></</span><span class="hl-11">p</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-6">// 3 functions to call when the Deferred object is resolved</span><br/><span class="hl-2">function</span><span class="hl-15"> </span><span class="hl-0">fn1</span><span class="hl-15">() {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">"p"</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">" 1 "</span><span class="hl-15"> );</span><br/><span class="hl-15">}</span><br/><span class="hl-2">function</span><span class="hl-15"> </span><span class="hl-0">fn2</span><span class="hl-15">() {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">"p"</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-3">" 2 "</span><span class="hl-15"> );</span><br/><span class="hl-15">}</span><br/><span class="hl-2">function</span><span class="hl-15"> </span><span class="hl-0">fn3</span><span class="hl-15">( </span><span class="hl-5">n</span><span class="hl-15"> ) {</span><br/><span class="hl-0">$</span><span class="hl-15">( </span><span class="hl-3">"p"</span><span class="hl-15"> ).</span><span class="hl-0">append</span><span class="hl-15">( </span><span class="hl-5">n</span><span class="hl-15"> </span><span class="hl-1
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#done">done</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1303</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="fail"><span>fail</span><a href="#fail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="fail-1"><span class="tsd-kind-call-signature">fail</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">failCallback</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">failCallbacks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#fail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object is rejected.</p>
|
|||
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">failCallback</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A function, or array of functions, that are called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">failCallbacks</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-4">See<a href="#see-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.fail/">https://api.jquery.com/deferred.fail/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-3">Since<a href="#since-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.5</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">get</span><span class="hl-1">( </span><span class="hl-3">"test.php"</span><span class="hl-1"> )</span><br/><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"$.get succeeded"</span><span class="hl-1"> );</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-0">fail</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"$.get failed!"</span><span class="hl-1"> );</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#fail">fail</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1324</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="pipe"><span class="deprecated">pipe</span><a href="#pipe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-1"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf">ANF</a> <span class=
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipeard"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajd"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeand"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrd"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjd"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnd"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrd"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjd"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnd"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrd"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjd"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernd"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipearf"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajf"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanf"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrf"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjf"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnf"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrf"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjf"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnf"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrf"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjf"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernf"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipearp"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajp"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanp"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrp"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjp"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnp"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrp"><span class="tsd-kind-type-parameter">CRP</span>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf">AJF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf">AJF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf">AJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf">ANF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf">BRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf">BJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf">BNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf">CRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf">CJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf">CNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf">RRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-sig
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-4">Since<a href="#since-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-5">Since<a href="#since-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="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--filter-reject-value">Example: ````Filter resolve value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
alert( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Filter reject value:<a href="#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--filter-reject-value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">defer</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">Deferred</span><span class="hl-1">(),</span><br/><span class="hl-5">filtered</span><span class="hl-1"> = </span><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">( </span><span class="hl-2">null</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">value</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">value</span><span class="hl-1"> * </span><span class="hl-9">3</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">reject</span><span class="hl-1">( </span><span class="hl-9">6</span><span class="hl-1"> );</span><br/><span class="hl-5">filtered</span><span class="hl-1">.</span><span class="hl-0">fail</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">value</span><span class="hl-1"> ) {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"Value is ( 3*6 = ) 18: "</span><span class="hl-1"> + </span><span class="hl-5">value</span><span class="hl-1"> );</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--chain-tasks">Example: ````Chain tasks:<a href="#example--chain-tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1474</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-2"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-1">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-1">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-1">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-1">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-1">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-1">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-1">CRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-1">CJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-1">CNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-1">RRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-1">RJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-1">RNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-1">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-1">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-1">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-1">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipearf-1"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajf-1"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanf-1"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrf-1"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjf-1"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnf-1"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrf-1"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjf-1"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnf-1"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrf-1"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjf-1"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernf-1"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipearp-1"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajp-1"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanp-1"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrp-1"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjp-1"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnp-1"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrp-1"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjp-1"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnp-1"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrp-1"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjp-1"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernp-1"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-1">AJF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-1">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-1">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-1">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-1">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-1">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-1">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-1">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-1">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-1">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-1">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-1">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-1">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-1">AJF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-1">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-1">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-1">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-1">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-1">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-1">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-1">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-1">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-1">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-1">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-1">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-1">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-1">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-1">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-1">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-1">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-1">AJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-1">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-1">ANF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-1">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-1">BRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-1">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-1">BJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-1">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-1">BNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-1">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-1">CRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-1">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-1">CJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-1">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-1">CNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-1">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-1">RRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-1">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-1">RJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-1">RJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-1">RNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-1">RNP</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-6">See<a href="#see-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-6">Since<a href="#since-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-7">Since<a href="#since-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferpipe-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferpipe-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1581</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-3"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-1">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-1">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-1">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-1">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-1">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-1">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-1">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-1">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-1">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-1">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-1">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-1">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-2">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-2">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-2">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-2">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipeard-1"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajd-1"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeand-1"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrd-1"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjd-1"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnd-1"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrd-1"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjd-1"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnd-1"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrd-1"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjd-1"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernd-1"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipearp-2"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajp-2"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanp-2"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrp-2"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjp-2"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnp-2"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrp-2"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjp-2"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnp-2"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrp-2"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjp-2"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernp-2"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-2">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-2">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-2">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-2">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-2">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-2">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-2">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-2">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-2">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-2">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-2">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-2">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-2">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-2">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-1">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-2">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-1">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-2">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-1">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-2">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-1">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-2">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-1">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-2">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-1">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-2">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-1">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-2">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-1">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-2">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-1">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-2">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-1">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-2">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-1">RJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-2">RJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-1">RND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-2">RNP</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-7">See<a href="#see-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-8">Since<a href="#since-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-9">Since<a href="#since-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="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">Example: ````Filter resolve value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
alert( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#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" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1671</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-4"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-3">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-3">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-3">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-3">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-3">BJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-3">BNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-3">CRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-3">CJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-3">CNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-3">RRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-3">RJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-3">RNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">failFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">progressFilter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipearp-3"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajp-3"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanp-3"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrp-3"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjp-3"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnp-3"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrp-3"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjp-3"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnp-3"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrp-3"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjp-3"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernp-3"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-3">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-3">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-3">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-3">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-3">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-3">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-3">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-3">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-3">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-3">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-3">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-3">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-3">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-3">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearp-3">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajp-3">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanp-3">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrp-3">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjp-3">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnp-3">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrp-3">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjp-3">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnp-3">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrp-3">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjp-3">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernp-3">RNP</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-8">See<a href="#see-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-10">Since<a href="#since-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-11">Since<a href="#since-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--chain-tasks-1">Example: ````Chain tasks:<a href="#example--chain-tasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1749</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-5"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-2">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-2">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-2">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-2">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-2">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-2">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-2">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-2">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-2">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-2">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-2">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-2">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-2">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-2">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-2">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-2">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipeard-2"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajd-2"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeand-2"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrd-2"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjd-2"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnd-2"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrd-2"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjd-2"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnd-2"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrd-2"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjd-2"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernd-2"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipearf-2"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajf-2"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanf-2"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrf-2"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjf-2"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnf-2"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrf-2"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjf-2"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnf-2"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrf-2"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjf-2"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernf-2"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-2">AJF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-2">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-2">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-2">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-2">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-2">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-2">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-2">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-2">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-2">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-2">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-2">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-2">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-2">AJF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-2">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-2">ARF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-2">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-2">AJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-2">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-2">ANF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-2">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-2">BRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-2">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-2">BJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-2">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-2">BNF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-2">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-2">CRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-2">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-2">CJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-2">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-2">CNF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-2">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-2">RRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-2">RJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-2">RJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-2">RND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-2">RNF</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-9">See<a href="#see-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-12">Since<a href="#since-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-13">Since<a href="#since-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-4">Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="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--filter-reject-value-1">Example: ````Filter resolve value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
alert( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Filter reject value:<a href="#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--filter-reject-value-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">defer</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">Deferred</span><span class="hl-1">(),</span><br/><span class="hl-5">filtered</span><span class="hl-1"> = </span><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">( </span><span class="hl-2">null</span><span class="hl-1">, </span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">value</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">value</span><span class="hl-1"> * </span><span class="hl-9">3</span><span class="hl-1">;</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">reject</span><span class="hl-1">( </span><span class="hl-9">6</span><span class="hl-1"> );</span><br/><span class="hl-5">filtered</span><span class="hl-1">.</span><span class="hl-0">fail</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">value</span><span class="hl-1"> ) {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"Value is ( 3*6 = ) 18: "</span><span class="hl-1"> + </span><span class="hl-5">value</span><span class="hl-1"> );</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--chain-tasks-2">Example: ````Chain tasks:<a href="#example--chain-tasks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1821</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-6"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-3">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-3">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-3">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-3">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-3">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-3">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-3">CRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-3">CJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-3">CNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-3">RRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-3">RJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-3">RNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">failFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipearf-3"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajf-3"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeanf-3"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrf-3"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjf-3"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnf-3"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrf-3"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjf-3"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnf-3"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrf-3"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjf-3"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernf-3"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-3">AJF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-3">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-3">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-3">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-3">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-3">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-3">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-3">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-3">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-3">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-3">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-3">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-3">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-3">AJF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipearf-3">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajf-3">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeanf-3">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrf-3">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjf-3">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnf-3">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrf-3">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjf-3">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnf-3">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrf-3">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjf-3">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernf-3">RNF</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-10">See<a href="#see-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-14">Since<a href="#since-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-15">Since<a href="#since-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-5">Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferpipe-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-1">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferpipe-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1911</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pipe-7"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-3">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-3">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-3">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-3">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-3">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-3">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-3">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-3">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-3">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-3">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-3">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-3">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/>
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="pipeard-3"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeajd-3"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipeand-3"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebrd-3"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebjd-3"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipebnd-3"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecrd-3"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecjd-3"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipecnd-3"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperrd-3"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="piperjd-3"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="pipernd-3"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-3">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-3">ARD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-3">AJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-3">AND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-3">BRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-3">BJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-3">BND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeard-3">ARD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeajd-3">AJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipeand-3">AND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebrd-3">BRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebjd-3">BJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipebnd-3">BND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecrd-3">CRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecjd-3">CJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipecnd-3">CND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperrd-3">RRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#piperjd-3">RJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipernd-3">RND</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-11">See<a href="#see-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-16">Since<a href="#since-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.6</p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-17">Since<a href="#since-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-6">Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../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><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="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">Example: ````Filter resolve value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.pipe(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
alert( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">pipe</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1971</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="progress"><span>progress</span><a href="#progress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="progress-1"><span class="tsd-kind-call-signature">progress</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">progressCallback</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">progressCallbacks</span><span class="tsd-signature-symbol">:</span> <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#progress-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add handlers to be called when the Deferred object generates progress notifications.</p>
|
|||
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">progressCallback</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A function, or array of functions, to be called when the Deferred generates progress notifications.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">progressCallbacks</span>: <a href="../types/Frontend_Script_API._internal_.TypeOrArray.html" class="tsd-signature-type tsd-kind-type-alias">TypeOrArray</a><span class="tsd-signature-symbol"><</span><a href="../types/Frontend_Script_API._internal_.CallbackBase.html" class="tsd-signature-type tsd-kind-type-alias">CallbackBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional additional functions, or arrays of functions, to be called when the Deferred generates
|
|||
|
|
progress notifications.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-12">See<a href="#see-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.progress/">https://api.jquery.com/deferred.progress/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-18">Since<a href="#since-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#progress">progress</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1336</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="promise"><span>promise</span><a href="#promise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="promise-1"><span class="tsd-kind-call-signature">promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#promisettarget">TTarget</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#promisettarget">TTarget</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-interface">JQueryPromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#promisettarget">TTarget</a><a href="#promise-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return a Deferred's Promise object.</p>
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="promisettarget"><span class="tsd-kind-type-parameter">TTarget</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#promisettarget">TTarget</a></span><div class="tsd-comment tsd-typography"><p>Object onto which the promise methods have to be attached</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-interface">JQueryPromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#promisettarget">TTarget</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-13">See<a href="#see-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-19">Since<a href="#since-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.5</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.<a href="#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"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-0">asyncEvent</span><span class="hl-1">() {</span><br/><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">dfd</span><span class="hl-1"> = </span><span class="hl-5">jQuery</span><span class="hl-1">.</span><span class="hl-0">Deferred</span><span class="hl-1">();</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Resolve after a random interval</span><br/><span class="hl-0">setTimeout</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-5">dfd</span><span class="hl-1">.</span><span class="hl-0">resolve</span><span class="hl-1">( </span><span class="hl-3">"hurray"</span><span class="hl-1"> );</span><br/><span class="hl-1">}, </span><span class="hl-5">Math</span><span class="hl-1">.</span><span class="hl-0">floor</span><span class="hl-1">( </span><span class="hl-9">400</span><span class="hl-1"> + </span><span class="hl-5">Math</span><span class="hl-1">.</span><span class="hl-0">random</span><span class="hl-1">() * </span><span class="hl-9">2000</span><span class="hl-1"> ) );</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Reject after a random interval</span><br/><span class="hl-0">setTimeout</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">() {</span><br/><span class="hl-5">dfd</span><span class="hl-1">.</span><span class="hl-0">reject</span><span class="hl-1">( </span><span class="hl-3">"sorry"</span><span class="hl-1"> );</span><br/><span class="hl-1">}, </span><span class="hl-5">Math</span><span class="hl-1">.</span><span class="hl-0">floor</span><span class="hl-1">( </span><span class="hl-9">400</span><span class="hl-1"> + </span><span class="hl-5">Math</span><span class="hl-1">.</span><span class="hl-0">random</span><span class="hl-1">() * </span><span class="hl-9">2000</span><span class="hl-1"> ) );</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Show a "working..." message every half-second</span><br/><span class="hl-0">setTimeout</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-0">working</span><span class="hl-1">() {</span><br/><span class="hl-4">if</span><span class="hl-1"> ( </span><span class="hl-5">dfd</span
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#promise">promise</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1386</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="promise-2"><span class="tsd-kind-call-signature">promise</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#promise-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return a Deferred's Promise object.</p>
|
|||
|
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-14">See<a href="#see-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-20">Since<a href="#since-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.5</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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:<a href="#example--use-the-target-argument-to-promote-an-existing-object-to-a-promise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-6">// Existing object</span><br/><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">obj</span><span class="hl-1"> = {</span><br/><span class="hl-0">hello</span><span class="hl-5">:</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">name</span><span class="hl-1"> ) {</span><br/><span class="hl-0">alert</span><span class="hl-1">( </span><span class="hl-3">"Hello "</span><span class="hl-1"> + </span><span class="hl-5">name</span><span class="hl-1"> );</span><br/><span class="hl-1">}</span><br/><span class="hl-1">},</span><br/><span class="hl-6">// Create a Deferred</span><br/><span class="hl-5">defer</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">Deferred</span><span class="hl-1">();</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Set object as a promise</span><br/><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">promise</span><span class="hl-1">( </span><span class="hl-5">obj</span><span class="hl-1"> );</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Resolve the deferred</span><br/><span class="hl-5">defer</span><span class="hl-1">.</span><span class="hl-0">resolve</span><span class="hl-1">( </span><span class="hl-3">"John"</span><span class="hl-1"> );</span><br/><span class="hl-1"></span><br/><span class="hl-6">// Use the object as a Promise</span><br/><span class="hl-5">obj</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">name</span><span class="hl-1"> ) {</span><br/><span class="hl-5">obj</span><span class="hl-1">.</span><span class="hl-0">hello</span><span class="hl-1">( </span><span class="hl-5">name</span><span class="hl-1"> ); </span><span class="hl-6">// Will alert "Hello John"</span><br/><span class="hl-1">}).</span><span class="hl-0">hello</span><span class="hl-1">( </span><span class="hl-3">"Karl"</span><span class="hl-1"> ); </span><span class="hl-6">// Will alert "Hello Karl"</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#promise">promise</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1414</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="state-1"><span class="tsd-kind-call-signature">state</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pending"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rejected"</span><a href="#state-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determine the current state of a Deferred object.</p>
|
|||
|
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">"pending"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"resolved"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rejected"</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-15">See<a href="#see-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.state/">https://api.jquery.com/deferred.state/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-21">Since<a href="#since-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.7</p>
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#state">state</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:1420</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="then"><span>then</span><a href="#then" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-1"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf">ANF</a> <span class="tsd-signature-sy
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenard"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajd"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenand"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrd"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjd"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnd"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrd"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjd"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnd"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrd"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjd"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnd"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenarf"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajf"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanf"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrf"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjf"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnf"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrf"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjf"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnf"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrf"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjf"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnf"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenarp"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajp"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanp"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrp"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjp"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnp"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrp"><span class="tsd-kind-type-parameter">CRP</span>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf">ARF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf">AJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf">ANF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf">BRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf">BJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf">BNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf">CRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf">CJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf">CNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf">RRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-sig
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-22">Since<a href="#since-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.
|
|||
|
|
```javascript
|
|||
|
|
$.get( "test.php" ).then(
|
|||
|
|
function() {
|
|||
|
|
alert( "$.get succeeded" );
|
|||
|
|
}, function() {
|
|||
|
|
alert( "$.get failed!" );
|
|||
|
|
}
|
|||
|
|
);
|
|||
|
|
```
|
|||
|
|
@example ````Filter the resolve value:<a href="#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" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10"><!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">"en"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">"utf-8"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">title</span><span class="hl-10">></span><span class="hl-1">deferred.then demo</span><span class="hl-10"></</span><span class="hl-11">title</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">"https://code.jquery.com/jquery-3.3.1.js"</span><span class="hl-10">></</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-10"></</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">body</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">button</span><span class="hl-10">></span><span class="hl-1">Filter Resolve</span><span class="hl-10"></</span><span class="hl-11">button</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">p</span><span class="hl-10">></</span><span class="hl-11">p</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-0">filterResolve</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-2">function</span><span class="hl-15">() {</span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-5">defer</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">$</span><span class="hl-15">.</span><span class="hl-0">Deferred</span><span class="hl-15">(),</span><br/><span class="hl-5">filtered</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">defer</span><span class="hl-15">.</span><span class="hl-0">then</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">value</span><span class="hl-15"> ) {</span><br/><span class="hl-4">return</span><span class="hl-15"> </span><span class="hl-5">value</span><span class="hl-15"> </span><span class="hl-1">*</span><span class="hl-15"> </span><span class="hl-9">2</span><span class="hl-15">;</span><br/><span class="hl-15">});</span><br/><span class="hl-15"></span><br/><span class="hl-5">defer</span><span class="hl-15">.</span><span class="hl-0">resolve</span><span class="hl-15">( </span><span class="hl-9">5</span><span class="hl-15"> );</span><br/><span class="hl-5">filtered</span><span class="hl-15">.</span><span class="hl-0">done</span><span class="hl-15">(</span><span class="hl-2">function</span><
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2074</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-2"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-1">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-1">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-1">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-1">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-1">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-1">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-1">CRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-1">CJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-1">CNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-1">RRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-1">RJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-1">RNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-1">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-1">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-1">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-1">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenarf-1"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajf-1"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanf-1"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrf-1"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjf-1"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnf-1"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrf-1"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjf-1"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnf-1"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrf-1"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjf-1"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnf-1"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenarp-1"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajp-1"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanp-1"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrp-1"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjp-1"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnp-1"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrp-1"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjp-1"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnp-1"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrp-1"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjp-1"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnp-1"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-1">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-1">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-1">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-1">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-1">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-1">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-1">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-1">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-1">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-1">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-1">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-1">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-1">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-1">ARF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-1">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-1">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-1">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-1">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-1">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-1">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-1">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-1">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-1">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-1">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-1">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-1">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-1">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-1">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-1">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-1">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-1">AJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-1">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-1">ANF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-1">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-1">BRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-1">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-1">BJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-1">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-1">BNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-1">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-1">CRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-1">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-1">CJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-1">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-1">CNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-1">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-1">RRF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-1">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-1">RJF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-1">RJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-1">RNF</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-1">RNP</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-17">See<a href="#see-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-23">Since<a href="#since-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-1">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2175</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-3"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-1">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-1">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-1">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-1">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-1">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-1">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-1">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-1">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-1">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-1">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-1">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-1">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-2">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-2">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-2">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-2">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenard-1"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajd-1"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenand-1"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrd-1"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjd-1"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnd-1"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrd-1"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjd-1"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnd-1"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrd-1"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjd-1"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnd-1"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenarp-2"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajp-2"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanp-2"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrp-2"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjp-2"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnp-2"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrp-2"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjp-2"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnp-2"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrp-2"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjp-2"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnp-2"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-2">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-2">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-2">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-2">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-2">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-2">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-2">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-2">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-2">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-2">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-2">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-2">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-2">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-2">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-1">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-2">ARP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-1">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-2">AJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-1">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-2">ANP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-1">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-2">BRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-1">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-2">BJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-1">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-2">BNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-1">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-2">CRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-1">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-2">CJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-1">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-2">CNP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-1">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-2">RRP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-1">RJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-2">RJP</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-1">RND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-2">RNP</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-18">See<a href="#see-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-24">Since<a href="#since-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-the-resolve-value-html-----deferredthen-demo-----filter-resolve----var-filterresolve--function--var-defer--deferred-filtered--deferthenfunction-value---return-value--2---deferresolve-5--filtereddonefunction-value----p-html-value-is--25---10---value------button-on-click-filterresolve-------example--chain-tasks">Example: ````Filter the resolve value:
|
|||
|
|
```html
|
|||
|
|
<!doctype html>
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<title>deferred.then demo</title>
|
|||
|
|
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
|
|||
|
|
<button>Filter Resolve</button>
|
|||
|
|
<p></p>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
var filterResolve = function() {
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
$( "button" ).on( "click", filterResolve );
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-the-resolve-value-html-----deferredthen-demo-----filter-resolve----var-filterresolve--function--var-defer--deferred-filtered--deferthenfunction-value---return-value--2---deferresolve-5--filtereddonefunction-value----p-html-value-is--25---10---value------button-on-click-filterresolve-------example--chain-tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2280</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-4"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-3">ARP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-3">AJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-3">ANP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-3">BRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-3">BJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-3">BNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-3">CRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-3">CJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-3">CNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-3">RRP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-3">RJP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-3">RNP</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">failFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">progressFilter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenarp-3"><span class="tsd-kind-type-parameter">ARP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajp-3"><span class="tsd-kind-type-parameter">AJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanp-3"><span class="tsd-kind-type-parameter">ANP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrp-3"><span class="tsd-kind-type-parameter">BRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjp-3"><span class="tsd-kind-type-parameter">BJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnp-3"><span class="tsd-kind-type-parameter">BNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrp-3"><span class="tsd-kind-type-parameter">CRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjp-3"><span class="tsd-kind-type-parameter">CJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnp-3"><span class="tsd-kind-type-parameter">CNP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrp-3"><span class="tsd-kind-type-parameter">RRP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjp-3"><span class="tsd-kind-type-parameter">RJP</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnp-3"><span class="tsd-kind-type-parameter">RNP</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-3">ANP</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-3">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-3">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-3">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-3">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-3">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-3">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-3">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-3">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-3">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-3">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-3">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-3">RNP</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-3">ANP</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarp-3">ARP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajp-3">AJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanp-3">ANP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrp-3">BRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjp-3">BJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnp-3">BNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrp-3">CRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjp-3">CJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnp-3">CNP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrp-3">RRP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjp-3">RJP</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnp-3">RNP</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-19">See<a href="#see-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-25">Since<a href="#since-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--chain-tasks-3">Example: ````Chain tasks:<a href="#example--chain-tasks-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2352</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-5"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-2">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-2">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-2">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-2">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-2">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-2">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-2">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-2">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-2">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-2">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-2">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-2">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-2">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-2">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-2">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-2">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a c
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenard-2"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajd-2"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenand-2"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrd-2"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjd-2"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnd-2"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrd-2"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjd-2"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnd-2"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrd-2"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjd-2"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnd-2"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenarf-2"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajf-2"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanf-2"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrf-2"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjf-2"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnf-2"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrf-2"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjf-2"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnf-2"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrf-2"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjf-2"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnf-2"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-2">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-2">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-2">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-2">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-2">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-2">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-2">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-2">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-2">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-2">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-2">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-2">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-2">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-2">ARF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-2">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-2">ARF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-2">AJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-2">AJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-2">AND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-2">ANF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-2">BRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-2">BRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-2">BJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-2">BJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-2">BND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-2">BNF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-2">CRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-2">CRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-2">CJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-2">CJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-2">CND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-2">CNF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-2">RRD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-2">RRF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-2">RJD</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-2">RJF</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-2">RND</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-2">RNF</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-20">See<a href="#see-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-26">Since<a href="#since-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="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.
|
|||
|
|
```javascript
|
|||
|
|
$.get( "test.php" ).then(
|
|||
|
|
function() {
|
|||
|
|
alert( "$.get succeeded" );
|
|||
|
|
}, function() {
|
|||
|
|
alert( "$.get failed!" );
|
|||
|
|
}
|
|||
|
|
);
|
|||
|
|
```
|
|||
|
|
@example ````Filter the resolve value:<a href="#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" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><span class="hl-10"><!</span><span class="hl-11">doctype</span><span class="hl-1"> </span><span class="hl-12">html</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">html</span><span class="hl-1"> </span><span class="hl-12">lang</span><span class="hl-1">=</span><span class="hl-13">"en"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">meta</span><span class="hl-1"> </span><span class="hl-12">charset</span><span class="hl-1">=</span><span class="hl-13">"utf-8"</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">title</span><span class="hl-10">></span><span class="hl-1">deferred.then demo</span><span class="hl-10"></</span><span class="hl-11">title</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-15"> </span><span class="hl-12">src</span><span class="hl-15">=</span><span class="hl-13">"https://code.jquery.com/jquery-3.3.1.js"</span><span class="hl-10">></</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-10"></</span><span class="hl-11">head</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">body</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">button</span><span class="hl-10">></span><span class="hl-1">Filter Resolve</span><span class="hl-10"></</span><span class="hl-11">button</span><span class="hl-10">></span><br/><span class="hl-10"><</span><span class="hl-11">p</span><span class="hl-10">></</span><span class="hl-11">p</span><span class="hl-10">></span><br/><span class="hl-1"></span><br/><span class="hl-10"><</span><span class="hl-11">script</span><span class="hl-10">></span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-0">filterResolve</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-2">function</span><span class="hl-15">() {</span><br/><span class="hl-2">var</span><span class="hl-15"> </span><span class="hl-5">defer</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">$</span><span class="hl-15">.</span><span class="hl-0">Deferred</span><span class="hl-15">(),</span><br/><span class="hl-5">filtered</span><span class="hl-15"> </span><span class="hl-1">=</span><span class="hl-15"> </span><span class="hl-5">defer</span><span class="hl-15">.</span><span class="hl-0">then</span><span class="hl-15">(</span><span class="hl-2">function</span><span class="hl-15">( </span><span class="hl-5">value</span><span class="hl-15"> ) {</span><br/><span class="hl-4">return</span><span class="hl-15"> </span><span class="hl-5">value</span><span class="hl-15"> </span><span class="hl-1">*</span><span class="hl-15"> </span><span class="hl-9">2</span><span class="hl-15">;</span><br/><span class="hl-15">});</span><br/><span class="hl-15"></span><br/><span class="hl-5">defer</span><span class="hl-15">.</span><span class="hl-0">resolve</span><span class="hl-15">( </span><span class="hl-9">5</span><span class="hl-15"> );</span><br/><span class="hl-5">filtered</span><span class="hl-15">.</span><span class="hl-0">done</span><span class="hl-15">(</span><span class="hl-2">function</span
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-2">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2449</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-6"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-3">ARF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-3">AJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-3">ANF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-3">BRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-3">BJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-3">BNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-3">CRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-3">CJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-3">CNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-3">RRF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-3">RJF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-3">RNF</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">failFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenarf-3"><span class="tsd-kind-type-parameter">ARF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajf-3"><span class="tsd-kind-type-parameter">AJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenanf-3"><span class="tsd-kind-type-parameter">ANF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrf-3"><span class="tsd-kind-type-parameter">BRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjf-3"><span class="tsd-kind-type-parameter">BJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnf-3"><span class="tsd-kind-type-parameter">BNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrf-3"><span class="tsd-kind-type-parameter">CRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjf-3"><span class="tsd-kind-type-parameter">CJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnf-3"><span class="tsd-kind-type-parameter">CNF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrf-3"><span class="tsd-kind-type-parameter">RRF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjf-3"><span class="tsd-kind-type-parameter">RJF</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnf-3"><span class="tsd-kind-type-parameter">RNF</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is resolved.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-3">ARF</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-3">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-3">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-3">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-3">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-3">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-3">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-3">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-3">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-3">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-3">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-3">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-3">RNF</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.Thenable.html" class="tsd-signature-type tsd-kind-interface">Thenable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-3">ARF</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenarf-3">ARF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajf-3">AJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenanf-3">ANF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrf-3">BRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjf-3">BJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnf-3">BNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrf-3">CRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjf-3">CJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnf-3">CNF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrf-3">RRF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjf-3">RJF</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnf-3">RNF</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-21">See<a href="#see-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-27">Since<a href="#since-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-3">Example: ````Filter reject value:
|
|||
|
|
```javascript
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then( null, function( value ) {
|
|||
|
|
return value * 3;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.reject( 6 );
|
|||
|
|
filtered.fail(function( value ) {
|
|||
|
|
alert( "Value is ( 3*6 = ) 18: " + value );
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-reject-value-javascript-var-defer--deferred-filtered--deferthen-null-function-value---return-value--3---deferreject-6--filteredfailfunction-value---alert-value-is--36---18---value----example--chain-tasks-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2533</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="then-7"><span class="tsd-kind-call-signature">then</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-3">ARD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-3">AJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-3">AND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-3">BRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-3">BJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-3">BND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-3">CRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-3">CJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-3">CND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-3">RRD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-3">RJD</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-3">RND</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">doneFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/>
|
|||
|
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="thenard-3"><span class="tsd-kind-type-parameter">ARD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenajd-3"><span class="tsd-kind-type-parameter">AJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenand-3"><span class="tsd-kind-type-parameter">AND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbrd-3"><span class="tsd-kind-type-parameter">BRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbjd-3"><span class="tsd-kind-type-parameter">BJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenbnd-3"><span class="tsd-kind-type-parameter">BND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencrd-3"><span class="tsd-kind-type-parameter">CRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencjd-3"><span class="tsd-kind-type-parameter">CJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thencnd-3"><span class="tsd-kind-type-parameter">CND</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrrd-3"><span class="tsd-kind-type-parameter">RRD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrjd-3"><span class="tsd-kind-type-parameter">RJD</span> = <span class="tsd-signature-type">never</span></span></li><li><span id="thenrnd-3"><span class="tsd-kind-type-parameter">RND</span> = <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doneFilter</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">u</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-3">ARD</a><br/> <span class="tsd-signature-symbol">|</span> <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-3">ARD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-3">AJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-3">AND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-3">BRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-3">BJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-3">BND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">failFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when the Deferred is rejected.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">progressFilter</span>: <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>An optional function that is called when progress notifications are sent to the Deferred.</p>
|
|||
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Frontend_Script_API._internal_.PromiseBase.html" class="tsd-signature-type tsd-kind-interface">PromiseBase</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#thenard-3">ARD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenajd-3">AJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenand-3">AND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbrd-3">BRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbjd-3">BJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenbnd-3">BND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencrd-3">CRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencjd-3">CJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thencnd-3">CND</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrrd-3">RRD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrjd-3">RJD</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#thenrnd-3">RND</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-22">See<a href="#see-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code><a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a></code></p>
|
|||
|
|
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-28">Since<a href="#since-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.8</p>
|
|||
|
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example--filter-the-resolve-value-html-----deferredthen-demo-----filter-resolve----var-filterresolve--function--var-defer--deferred-filtered--deferthenfunction-value---return-value--2---deferresolve-5--filtereddonefunction-value----p-html-value-is--25---10---value------button-on-click-filterresolve-------example--chain-tasks-1">Example: ````Filter the resolve value:
|
|||
|
|
```html
|
|||
|
|
<!doctype html>
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<title>deferred.then demo</title>
|
|||
|
|
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
|
|||
|
|
<button>Filter Resolve</button>
|
|||
|
|
<p></p>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
var filterResolve = function() {
|
|||
|
|
var defer = $.Deferred(),
|
|||
|
|
filtered = defer.then(function( value ) {
|
|||
|
|
return value * 2;
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
defer.resolve( 5 );
|
|||
|
|
filtered.done(function( value ) {
|
|||
|
|
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
|
|||
|
|
});
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
$( "button" ).on( "click", filterResolve );
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|
|||
|
|
```
|
|||
|
|
@example ````Chain tasks:<a href="#example--filter-the-resolve-value-html-----deferredthen-demo-----filter-resolve----var-filterresolve--function--var-defer--deferred-filtered--deferthenfunction-value---return-value--2---deferresolve-5--filtereddonefunction-value----p-html-value-is--25---10---value------button-on-click-filterresolve-------example--chain-tasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="javascript"><span class="hl-2">var</span><span class="hl-1"> </span><span class="hl-5">request</span><span class="hl-1"> = </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url</span><span class="hl-1">, { </span><span class="hl-5">dataType:</span><span class="hl-1"> </span><span class="hl-3">"json"</span><span class="hl-1"> } ),</span><br/><span class="hl-5">chained</span><span class="hl-1"> = </span><span class="hl-5">request</span><span class="hl-1">.</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-4">return</span><span class="hl-1"> </span><span class="hl-5">$</span><span class="hl-1">.</span><span class="hl-0">ajax</span><span class="hl-1">( </span><span class="hl-5">url2</span><span class="hl-1">, { </span><span class="hl-5">data:</span><span class="hl-1"> { </span><span class="hl-5">user:</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">userId</span><span class="hl-1"> } } );</span><br/><span class="hl-1">});</span><br/><span class="hl-1"></span><br/><span class="hl-5">chained</span><span class="hl-1">.</span><span class="hl-0">done</span><span class="hl-1">(</span><span class="hl-2">function</span><span class="hl-1">( </span><span class="hl-5">data</span><span class="hl-1"> ) {</span><br/><span class="hl-6">// data retrieved from url2 as provided by the first request</span><br/><span class="hl-1">});</span>
|
|||
|
|
</code><button type="button">Copy</button></pre>
|
|||
|
|
|
|||
|
|
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Frontend_Script_API._internal_.Promise.html">Promise</a>.<a href="Frontend_Script_API._internal_.Promise.html#then">then</a></p><ul><li>Defined in node_modules/@types/jquery/misc.d.ts:2608</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#always" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>always</span></a><a href="#catch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>catch</span></a><a href="#done" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>done</span></a><a href="#fail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail</span></a><a href="#pipe" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons
|