actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
769 lines • 46.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ActionProcessor | 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="actionprocessor.html">ActionProcessor</a>
</li>
</ul>
<h1>Class ActionProcessor</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>
<span class="target">ActionProcessor</span>
</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="actionprocessor.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="actionprocessor.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#actionstarttime" class="tsd-kind-icon">action<wbr>Start<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#actionstatus" class="tsd-kind-icon">action<wbr>Status</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#actiontemplate" class="tsd-kind-icon">action<wbr>Template</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#connection" class="tsd-kind-icon">connection</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#duration" class="tsd-kind-icon">duration</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#messageid" class="tsd-kind-icon">message<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#missingparams" class="tsd-kind-icon">missing<wbr>Params</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#response" class="tsd-kind-icon">response</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#session" class="tsd-kind-icon">session</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#toprocess" class="tsd-kind-icon">to<wbr>Process</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#torender" class="tsd-kind-icon">to<wbr>Render</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#validatorerrors" class="tsd-kind-icon">validator<wbr>Errors</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="actionprocessor.html#working" class="tsd-kind-icon">working</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="actionprocessor.html#completeaction" class="tsd-kind-icon">complete<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="actionprocessor.html#getpendingactioncount" class="tsd-kind-icon">get<wbr>Pending<wbr>Action<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#incrementpendingactions" class="tsd-kind-icon">increment<wbr>Pending<wbr>Actions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#incrementtotalactions" class="tsd-kind-icon">increment<wbr>Total<wbr>Actions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="actionprocessor.html#lockparams" class="tsd-kind-icon">lock<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#logaction" class="tsd-kind-icon">log<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#postprocessaction" class="tsd-kind-icon">post<wbr>Process<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#preprocessaction" class="tsd-kind-icon">pre<wbr>Process<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#preparestringmethod" class="tsd-kind-icon">prepare<wbr>String<wbr>Method</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="actionprocessor.html#processaction" class="tsd-kind-icon">process<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#reduceparams" class="tsd-kind-icon">reduce<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#runaction" class="tsd-kind-icon">run<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#validateparam" class="tsd-kind-icon">validate<wbr>Param</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="actionprocessor.html#validateparams" class="tsd-kind-icon">validate<wbr>Params</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>Action<wbr>Processor<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="actionprocessor.html" class="tsd-signature-type">ActionProcessor</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/actionProcessor.ts#L31">src/classes/actionProcessor.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>connection: <a href="connection.html" class="tsd-signature-type">Connection</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="actionprocessor.html" class="tsd-signature-type">ActionProcessor</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="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<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/actionProcessor.ts#L12">src/classes/actionProcessor.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="actionstarttime" class="tsd-anchor"></a>
<h3>action<wbr>Start<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">action<wbr>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/actionhero/actionhero/blob/fd12b4f0/src/classes/actionProcessor.ts#L21">src/classes/actionProcessor.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="actionstatus" class="tsd-anchor"></a>
<h3>action<wbr>Status</h3>
<div class="tsd-signature tsd-kind-icon">action<wbr>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/actionProcessor.ts#L28">src/classes/actionProcessor.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="actiontemplate" class="tsd-anchor"></a>
<h3>action<wbr>Template</h3>
<div class="tsd-signature tsd-kind-icon">action<wbr>Template<span class="tsd-signature-symbol">:</span> <a href="action.html" class="tsd-signature-type">Action</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/actionProcessor.ts#L22">src/classes/actionProcessor.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="connection" class="tsd-anchor"></a>
<h3>connection</h3>
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <a href="connection.html" class="tsd-signature-type">Connection</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/actionProcessor.ts#L11">src/classes/actionProcessor.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="duration" class="tsd-anchor"></a>
<h3>duration</h3>
<div class="tsd-signature tsd-kind-icon">duration<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/actionProcessor.ts#L27">src/classes/actionProcessor.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="messageid" class="tsd-anchor"></a>
<h3>message<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">message<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><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/actionProcessor.ts#L15">src/classes/actionProcessor.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="missingparams" class="tsd-anchor"></a>
<h3>missing<wbr>Params</h3>
<div class="tsd-signature tsd-kind-icon">missing<wbr>Params<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/actionProcessor.ts#L19">src/classes/actionProcessor.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<div class="tsd-signature tsd-kind-icon">params<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/actionProcessor.ts#L16">src/classes/actionProcessor.ts:16</a></li>
</ul>
</aside>
<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="response" class="tsd-anchor"></a>
<h3>response</h3>
<div class="tsd-signature tsd-kind-icon">response<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/actionProcessor.ts#L24">src/classes/actionProcessor.ts:24</a></li>
</ul>
</aside>
<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="session" class="tsd-anchor"></a>
<h3>session</h3>
<div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/actionProcessor.ts#L31">src/classes/actionProcessor.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="toprocess" class="tsd-anchor"></a>
<h3>to<wbr>Process</h3>
<div class="tsd-signature tsd-kind-icon">to<wbr>Process<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/actionProcessor.ts#L13">src/classes/actionProcessor.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="torender" class="tsd-anchor"></a>
<h3>to<wbr>Render</h3>
<div class="tsd-signature tsd-kind-icon">to<wbr>Render<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/actionProcessor.ts#L14">src/classes/actionProcessor.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="validatorerrors" class="tsd-anchor"></a>
<h3>validator<wbr>Errors</h3>
<div class="tsd-signature tsd-kind-icon">validator<wbr>Errors<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><span class="tsd-signature-type">Error</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/actionProcessor.ts#L20">src/classes/actionProcessor.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="working" class="tsd-anchor"></a>
<h3>working</h3>
<div class="tsd-signature tsd-kind-icon">working<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/actionProcessor.ts#L23">src/classes/actionProcessor.ts:23</a></li>
</ul>
</aside>
</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="completeaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> complete<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">complete<wbr>Action<span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</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">this</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/actionProcessor.ts#L66">src/classes/actionProcessor.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> status: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</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">this</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="getpendingactioncount" class="tsd-anchor"></a>
<h3>get<wbr>Pending<wbr>Action<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Pending<wbr>Action<wbr>Count<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/actionProcessor.ts#L62">src/classes/actionProcessor.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="incrementpendingactions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> increment<wbr>Pending<wbr>Actions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">increment<wbr>Pending<wbr>Actions<span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/actionProcessor.ts#L55">src/classes/actionProcessor.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> count: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="incrementtotalactions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> increment<wbr>Total<wbr>Actions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">increment<wbr>Total<wbr>Actions<span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/actionProcessor.ts#L51">src/classes/actionProcessor.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> count: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="lockparams" class="tsd-anchor"></a>
<h3>lock<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">lock<wbr>Params<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/actionProcessor.ts#L307">src/classes/actionProcessor.ts:307</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="logaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> log<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">log<wbr>Action<span class="tsd-signature-symbol">(</span>error<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">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/actionProcessor.ts#L110">src/classes/actionProcessor.ts:110</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="postprocessaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> post<wbr>Process<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">post<wbr>Process<wbr>Action<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">void</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/actionProcessor.ts#L161">src/classes/actionProcessor.ts:161</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="preprocessaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> pre<wbr>Process<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">pre<wbr>Process<wbr>Action<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">void</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/actionProcessor.ts#L144">src/classes/actionProcessor.ts:144</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="preparestringmethod" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> prepare<wbr>String<wbr>Method</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">prepare<wbr>String<wbr>Method<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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/actionProcessor.ts#L200">src/classes/actionProcessor.ts:200</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>method: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="processaction" class="tsd-anchor"></a>
<h3>process<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">process<wbr>Action<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">this</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/actionProcessor.ts#L311">src/classes/actionProcessor.ts:311</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="reduceparams" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> reduce<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">reduce<wbr>Params<span class="tsd-signature-symbol">(</span>schemaKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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/actionProcessor.ts#L178">src/classes/actionProcessor.ts:178</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> schemaKey: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="runaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> run<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">run<wbr>Action<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">this</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/actionProcessor.ts#L353">src/classes/actionProcessor.ts:353</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="validateparam" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> validate<wbr>Param</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">validate<wbr>Param<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, schemaKey<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">void</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/actionProcessor.ts#L209">src/classes/actionProcessor.ts:209</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>props: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>params: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>key: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>schemaKey: <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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="validateparams" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> validate<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">validate<wbr>Params<span class="tsd-signature-symbol">(</span>schemaKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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">void</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/actionProcessor.ts#L287">src/classes/actionProcessor.ts:287</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> schemaKey: <span class="tsd-signature-type">string</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">void</span><span class="tsd-signature-symbol">></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="actionprocessor.html" class="tsd-kind-icon">Action<wbr>Processor</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="actionprocessor.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#actionstarttime" class="tsd-kind-icon">action<wbr>Start<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#actionstatus" class="tsd-kind-icon">action<wbr>Status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#actiontemplate" class="tsd-kind-icon">action<wbr>Template</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#connection" class="tsd-kind-icon">connection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#duration" class="tsd-kind-icon">duration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#messageid" class="tsd-kind-icon">message<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#missingparams" class="tsd-kind-icon">missing<wbr>Params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#response" class="tsd-kind-icon">response</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#session" class="tsd-kind-icon">session</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#toprocess" class="tsd-kind-icon">to<wbr>Process</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#torender" class="tsd-kind-icon">to<wbr>Render</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#validatorerrors" class="tsd-kind-icon">validator<wbr>Errors</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="actionprocessor.html#working" class="tsd-kind-icon">working</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#completeaction" class="tsd-kind-icon">complete<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="actionprocessor.html#getpendingactioncount" class="tsd-kind-icon">get<wbr>Pending<wbr>Action<wbr>Count</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#incrementpendingactions" class="tsd-kind-icon">increment<wbr>Pending<wbr>Actions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#incrementtotalactions" class="tsd-kind-icon">increment<wbr>Total<wbr>Actions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="actionprocessor.html#lockparams" class="tsd-kind-icon">lock<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#logaction" class="tsd-kind-icon">log<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#postprocessaction" class="tsd-kind-icon">post<wbr>Process<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#preprocessaction" class="tsd-kind-icon">pre<wbr>Process<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#preparestringmethod" class="tsd-kind-icon">prepare<wbr>String<wbr>Method</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="actionprocessor.html#processaction" class="tsd-kind-icon">process<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#reduceparams" class="tsd-kind-icon">reduce<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#runaction" class="tsd-kind-icon">run<wbr>Action</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#validateparam" class="tsd-kind-icon">validate<wbr>Param</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="actionprocessor.html#validateparams" class="tsd-kind-icon">validate<wbr>Params</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>