UNPKG

povtor

Version:

Repeat function call depending on the previous call result and specified conditions.

470 lines 24.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>RetryResult | povtor</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">povtor</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_index_.html">&quot;index&quot;</a> </li> <li> <a href="_index_.retryresult.html">RetryResult</a> </li> </ul> <h1>Interface RetryResult</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_index_.withpromisefield.html" class="tsd-signature-type">WithPromiseField</a> <ul class="tsd-hierarchy"> <li> <span class="target">RetryResult</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#attempt" class="tsd-kind-icon">attempt</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#error" class="tsd-kind-icon">error</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#iserror" class="tsd-kind-icon">is<wbr>Error</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_index_.retryresult.html#promise" class="tsd-kind-icon">promise</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#result" class="tsd-kind-icon">result</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#settings" class="tsd-kind-icon">settings</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#starttime" class="tsd-kind-icon">start<wbr>Time</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#stopped" class="tsd-kind-icon">stopped</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#value" class="tsd-kind-icon">value</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#valuewait" class="tsd-kind-icon">value<wbr>Wait</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_index_.retryresult.html#wait" class="tsd-kind-icon">wait</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="attempt" class="tsd-anchor"></a> <h3>attempt</h3> <div class="tsd-signature tsd-kind-icon">attempt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L84">index.ts:84</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Number of calls of the action function that have already made.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="error" class="tsd-anchor"></a> <h3>error</h3> <div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L86">index.ts:86</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Last error or value of promise rejection.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="iserror" class="tsd-anchor"></a> <h3>is<wbr>Error</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L88">index.ts:88</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the last call of the action function is ended with error.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a name="promise" class="tsd-anchor"></a> <h3>promise</h3> <div class="tsd-signature tsd-kind-icon">promise<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_index_.withpromisefield.html">WithPromiseField</a>.<a href="_index_.withpromisefield.html#promise">promise</a></p> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L79">index.ts:79</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="result" class="tsd-anchor"></a> <h3>result</h3> <div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.html#actioncallresult" class="tsd-signature-type">ActionCallResult</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L90">index.ts:90</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Contains result of each call of the action function.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="settings" class="tsd-anchor"></a> <h3>settings</h3> <div class="tsd-signature tsd-kind-icon">settings<span class="tsd-signature-symbol">:</span> <a href="_index_.retrysettings.html" class="tsd-signature-type">RetrySettings</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L92">index.ts:92</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Settings that were passed to <a href="../modules/_index_.html#retry"><code>retry</code></a> function.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="starttime" class="tsd-anchor"></a> <h3>start<wbr>Time</h3> <div class="tsd-signature tsd-kind-icon">start<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L94">index.ts:94</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Time in milliseconds when <a href="../modules/_index_.html#retry"><code>retry</code></a> function was called.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="stop" class="tsd-anchor"></a> <h3>stop</h3> <div class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L96">index.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Function that can be used to stop the process of calls repeating. Returns value of <code>promise</code> field.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="stopped" class="tsd-anchor"></a> <h3>stopped</h3> <div class="tsd-signature tsd-kind-icon">stopped<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L98">index.ts:98</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A boolean value that indicates whether the process of calls repeating is stopped.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="value" class="tsd-anchor"></a> <h3>value</h3> <div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L103">index.ts:103</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A value of last successfull call of the action function. When the action function returns a promise, the value will be result of the promise fulfillment.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="valuewait" class="tsd-anchor"></a> <h3>value<wbr>Wait</h3> <div class="tsd-signature tsd-kind-icon">value<wbr>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L108">index.ts:108</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A boolean value that indicates whether the action function is producing a result. Useful only when the action function returns a promise. Is set to <code>true</code> when the promise is pending.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="wait" class="tsd-anchor"></a> <h3>wait</h3> <div class="tsd-signature tsd-kind-icon">wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L113">index.ts:113</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A boolean value that indicates waiting of the next call of the action function. Is set to <code>true</code> during a timeout between calls.</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_index_.html">&quot;index&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_index_.errorresult.html" class="tsd-kind-icon">Error<wbr>Result</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_index_.retryresult.html" class="tsd-kind-icon">Retry<wbr>Result</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#attempt" class="tsd-kind-icon">attempt</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#error" class="tsd-kind-icon">error</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#iserror" class="tsd-kind-icon">is<wbr>Error</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> <a href="_index_.retryresult.html#promise" class="tsd-kind-icon">promise</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#result" class="tsd-kind-icon">result</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#settings" class="tsd-kind-icon">settings</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#starttime" class="tsd-kind-icon">start<wbr>Time</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#stop" class="tsd-kind-icon">stop</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#stopped" class="tsd-kind-icon">stopped</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#value" class="tsd-kind-icon">value</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#valuewait" class="tsd-kind-icon">value<wbr>Wait</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_index_.retryresult.html#wait" class="tsd-kind-icon">wait</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_index_.retrysettings.html" class="tsd-kind-icon">Retry<wbr>Settings</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_index_.valueresult.html" class="tsd-kind-icon">Value<wbr>Result</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_index_.withpromisefield.html" class="tsd-kind-icon">With<wbr>Promise<wbr>Field</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_index_.html#actioncallresult" class="tsd-kind-icon">Action<wbr>Call<wbr>Result</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_index_.html#getretrytimeout" class="tsd-kind-icon">Get<wbr>Retry<wbr>Timeout</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_index_.html#retryaction" class="tsd-kind-icon">Retry<wbr>Action</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_index_.html#retrytest" class="tsd-kind-icon">Retry<wbr>Test</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_index_.html#retrytimeout" class="tsd-kind-icon">Retry<wbr>Timeout</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_index_.html#getpromisefield" class="tsd-kind-icon">get<wbr>Promise<wbr>Field</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_index_.html#retry" class="tsd-kind-icon">retry</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>