actionhero

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Task | actionhero</title> <meta name="description" content="Documentation for actionhero"> <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.json" 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">actionhero</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="task.html">Task</a> </li> </ul> <h1>Class Task</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a new Actionhero Task. The required properties of an task. These can be defined statically (this.name) or as methods which return a value.</p> <pre><code class="language-js"><span class="hljs-keyword">const</span> { Task, api, log } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'actionhero'</span>) <span class="hljs-built_in">module</span>.exports = <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">SayHello</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Task</span> </span>{ <span class="hljs-keyword">constructor</span> () { <span class="hljs-keyword">super</span>() <span class="hljs-keyword">this</span>.name = <span class="hljs-string">'sayHello'</span> <span class="hljs-keyword">this</span>.description = <span class="hljs-string">'I say Hello every minute'</span> <span class="hljs-keyword">this</span>.frequency = (<span class="hljs-number">60</span> * <span class="hljs-number">1000</span>) } <span class="hljs-keyword">async</span> run (data, worker) { log(<span class="hljs-string">'Hello!'</span>) } }</code></pre> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Task</span> <ul class="tsd-hierarchy"> <li> <a href="runaction.html" class="tsd-signature-type">RunAction</a> </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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="task.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#description" class="tsd-kind-icon">description</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#frequency" class="tsd-kind-icon">frequency</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#inputs" class="tsd-kind-icon">inputs</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#middleware" class="tsd-kind-icon">middleware</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#pluginoptions" class="tsd-kind-icon">plugin<wbr>Options</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#plugins" class="tsd-kind-icon">plugins</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#queue" class="tsd-kind-icon">queue</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="task.html#reenqueueperiodictaskifexception" class="tsd-kind-icon">re<wbr>Enqueue<wbr>Periodic<wbr>Task<wbr>IfException</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="task.html#defaults" class="tsd-kind-icon">defaults</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="task.html#run" class="tsd-kind-icon">run</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="task.html#validate" class="tsd-kind-icon">validate</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Task<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="task.html" class="tsd-signature-type">Task</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L38">src/classes/task.ts:38</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="task.html" class="tsd-signature-type">Task</a></h4> </li> </ul> </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-class"> <a name="description" class="tsd-anchor"></a> <h3>description</h3> <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L24">src/classes/task.ts:24</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The description of the Task (default this.name)</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="frequency" class="tsd-anchor"></a> <h3>frequency</h3> <div class="tsd-signature tsd-kind-icon">frequency<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/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L26">src/classes/task.ts:26</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>How often to run this Task, in ms. 0 is non-recurring. (default: 0)</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="inputs" class="tsd-anchor"></a> <h3>inputs</h3> <div class="tsd-signature tsd-kind-icon">inputs<span class="tsd-signature-symbol">:</span> <a href="../interfaces/inputs.html" class="tsd-signature-type">Inputs</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L28">src/classes/task.ts:28</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The inputs of the Task (default: {})</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="middleware" class="tsd-anchor"></a> <h3>middleware</h3> <div class="tsd-signature tsd-kind-icon">middleware<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L30">src/classes/task.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The Middleware specific to this Task (default: []). Middleware is described by the string names of the middleware</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="name" class="tsd-anchor"></a> <h3>name</h3> <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L22">src/classes/task.ts:22</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The name of the Task</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="pluginoptions" class="tsd-anchor"></a> <h3>plugin<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">plugin<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L34">src/classes/task.ts:34</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Options for the node-resque plugins.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="plugins" class="tsd-anchor"></a> <h3>plugins</h3> <div class="tsd-signature tsd-kind-icon">plugins<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L32">src/classes/task.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Plugins from node-resque to use on this task (default: []). Plugins like <code>QueueLock can be applied</code></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="queue" class="tsd-anchor"></a> <h3>queue</h3> <div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L36">src/classes/task.ts:36</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The default queue to run this Task on (default: 'default')</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="reenqueueperiodictaskifexception" class="tsd-anchor"></a> <h3>re<wbr>Enqueue<wbr>Periodic<wbr>Task<wbr>IfException</h3> <div class="tsd-signature tsd-kind-icon">re<wbr>Enqueue<wbr>Periodic<wbr>Task<wbr>IfException<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/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L38">src/classes/task.ts:38</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Re-enqueuing a periodic task in the case of an exception. (default: false)</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="defaults" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> defaults</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">defaults<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>frequency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>middleware<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pluginOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>plugins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>queue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reEnqueuePeriodicTaskIfException<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L60">src/classes/task.ts:60</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>frequency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>middleware<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pluginOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>plugins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>queue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reEnqueuePeriodicTaskIfException<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>frequency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>middleware<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span></h5> </li> <li class="tsd-parameter"> <h5>plugin<wbr>Options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <ul class="tsd-parameters"> </ul> </li> <li class="tsd-parameter"> <h5>plugins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>queue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>re<wbr>Enqueue<wbr>Periodic<wbr>Task<wbr>IfException<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="run" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> run</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/taskdata.html" class="tsd-signature-type">TaskData</a>, worker<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L58">src/classes/task.ts:58</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The main "do something" method for this task. It can be <code>async</code>. Anything returned from this method will be logged. If error is thrown in this method, it will be logged & caught. Using middleware, you can decide to re-run the task on failure. <code>this</code> is a Task instance itself now.</p> </div> <p>Inputs:</p> <ul> <li>data: The data about this instance of the task, specifically params.</li> <li>worker: Instance of a node-resque worker. You can inspect <code>worker.job</code> and set <code>worker.result</code> explicitly if your Task does not return a value.</li> </ul> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <a href="../interfaces/taskdata.html" class="tsd-signature-type">TaskData</a></h5> </li> <li> <h5>worker: <span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="validate" class="tsd-anchor"></a> <h3>validate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/task.ts#L73">src/classes/task.ts:73</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </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> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="task.html" class="tsd-kind-icon">Task</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="task.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#description" class="tsd-kind-icon">description</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#frequency" class="tsd-kind-icon">frequency</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#inputs" class="tsd-kind-icon">inputs</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#middleware" class="tsd-kind-icon">middleware</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#pluginoptions" class="tsd-kind-icon">plugin<wbr>Options</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#plugins" class="tsd-kind-icon">plugins</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#queue" class="tsd-kind-icon">queue</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="task.html#reenqueueperiodictaskifexception" class="tsd-kind-icon">re<wbr>Enqueue<wbr>Periodic<wbr>Task<wbr>IfException</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="task.html#defaults" class="tsd-kind-icon">defaults</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="task.html#run" class="tsd-kind-icon">run</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="task.html#validate" class="tsd-kind-icon">validate</a> </li> </ul> </li> </ul> <ul class="after-current"> </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-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> </ul> <ul class="tsd-legend"> <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> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method 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>