povtor
Version:
Repeat function call depending on the previous call result and specified conditions.
421 lines • 25.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"index" | 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="_index_.html">"index"</a>
</li>
</ul>
<h1>External module "index"</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.errorresult.html" class="tsd-kind-icon">Error<wbr>Result</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.retryresult.html" class="tsd-kind-icon">Retry<wbr>Result</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.retrysettings.html" class="tsd-kind-icon">Retry<wbr>Settings</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.valueresult.html" class="tsd-kind-icon">Value<wbr>Result</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.withpromisefield.html" class="tsd-kind-icon">With<wbr>Promise<wbr>Field</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_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="_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="_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="_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="_index_.html#retrytimeout" class="tsd-kind-icon">Retry<wbr>Timeout</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_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="_index_.html#retry" class="tsd-kind-icon">retry</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="actioncallresult" class="tsd-anchor"></a>
<h3>Action<wbr>Call<wbr>Result</h3>
<div class="tsd-signature tsd-kind-icon">Action<wbr>Call<wbr>Result<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_index_.valueresult.html" class="tsd-signature-type">ValueResult</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_index_.errorresult.html" class="tsd-signature-type">ErrorResult</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L76">index.ts:76</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="getretrytimeout" class="tsd-anchor"></a>
<h3>Get<wbr>Retry<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">Get<wbr>Retry<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a><span class="tsd-signature-symbol">)</span><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#L3">index.ts:3</a></li>
</ul>
</aside>
<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-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="retryaction" class="tsd-anchor"></a>
<h3>Retry<wbr>Action</h3>
<div class="tsd-signature tsd-kind-icon">Retry<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><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#L1">index.ts:1</a></li>
</ul>
</aside>
<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-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">unknown</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">unknown</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="retrytest" class="tsd-anchor"></a>
<h3>Retry<wbr>Test</h3>
<div class="tsd-signature tsd-kind-icon">Retry<wbr>Test<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span>, result<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a><span class="tsd-signature-symbol">)</span><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#L6">index.ts:6</a></li>
</ul>
</aside>
<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-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span>, result<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <span class="tsd-signature-type">unknown</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="retrytimeout" class="tsd-anchor"></a>
<h3>Retry<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">Retry<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="_index_.html#getretrytimeout" class="tsd-signature-type">GetRetryTimeout</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L4">index.ts:4</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="getpromisefield" class="tsd-anchor"></a>
<h3>get<wbr>Promise<wbr>Field</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Promise<wbr>Field<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.withpromisefield.html" class="tsd-signature-type">WithPromiseField</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L308">index.ts:308</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return value of <code>promise</code> field of the passed object.</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>Denis Sikuler</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>obj: <a href="../interfaces/_index_.withpromisefield.html" class="tsd-signature-type">WithPromiseField</a></h5>
<div class="tsd-comment tsd-typography">
<p> Object whose field should be returned.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4>
<p> Value of <code>promise</code> field of the passed object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="retry" class="tsd-anchor"></a>
<h3>retry</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">retry<span class="tsd-signature-symbol">(</span>settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.retrysettings.html" class="tsd-signature-type">RetrySettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gamtiq/povtor/blob/master/src/index.ts#L125">index.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Call specified function and repeat calls depending on settings.</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>Denis Sikuler</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>settings: <a href="../interfaces/_index_.retrysettings.html" class="tsd-signature-type">RetrySettings</a></h5>
<div class="tsd-comment tsd-typography">
<p> Operation settings.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_index_.retryresult.html" class="tsd-signature-type">RetryResult</a></h4>
<p> Object that can be used to observe and control the process of calls repeating.</p>
</li>
</ul>
</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="_index_.html">"index"</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="../interfaces/_index_.errorresult.html" class="tsd-kind-icon">Error<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.retryresult.html" class="tsd-kind-icon">Retry<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.retrysettings.html" class="tsd-kind-icon">Retry<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.valueresult.html" class="tsd-kind-icon">Value<wbr>Result</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_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="_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="_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="_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="_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="_index_.html#retrytimeout" class="tsd-kind-icon">Retry<wbr>Timeout</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_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="_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>