actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
437 lines • 23 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Api | 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="api.html">Api</a>
</li>
</ul>
<h1>Class Api</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">Api</span>
</li>
</ul>
</section>
<section class="tsd-panel tsd-kind-class">
<h3 class="tsd-before-signature">Indexable</h3>
<div class="tsd-signature tsd-kind-icon"><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></div>
</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="api.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="api.html#actions" class="tsd-kind-icon">actions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#boottime" class="tsd-kind-icon">boot<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#chatroom" class="tsd-kind-icon">chat<wbr>Room</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#commands" class="tsd-kind-icon">commands</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#connections" class="tsd-kind-icon">connections</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#documentation" class="tsd-kind-icon">documentation</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#exceptionhandlers" class="tsd-kind-icon">exception<wbr>Handlers</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#process" class="tsd-kind-icon">process</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#redis" class="tsd-kind-icon">redis</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#resque" class="tsd-kind-icon">resque</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#routes" class="tsd-kind-icon">routes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#running" class="tsd-kind-icon">running</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#servers" class="tsd-kind-icon">servers</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#spechelper" class="tsd-kind-icon">spec<wbr>Helper</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#staticfile" class="tsd-kind-icon">static<wbr>File</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="api.html#tasks" class="tsd-kind-icon">tasks</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>Api<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="api.html" class="tsd-signature-type">Api</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/api.ts#L46">src/classes/api.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="api.html" class="tsd-signature-type">Api</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="actions" class="tsd-anchor"></a>
<h3>actions</h3>
<div class="tsd-signature tsd-kind-icon">actions<span class="tsd-signature-symbol">:</span> <a href="../interfaces/actionsapi.html" class="tsd-signature-type">ActionsApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L31">src/classes/api.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="boottime" class="tsd-anchor"></a>
<h3>boot<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">boot<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/api.ts#L19">src/classes/api.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="chatroom" class="tsd-anchor"></a>
<h3>chat<wbr>Room</h3>
<div class="tsd-signature tsd-kind-icon">chat<wbr>Room<span class="tsd-signature-symbol">:</span> <a href="../interfaces/chatroomapi.html" class="tsd-signature-type">ChatRoomApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L34">src/classes/api.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="commands" class="tsd-anchor"></a>
<h3>commands</h3>
<div class="tsd-signature tsd-kind-icon">commands<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>initialize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">; </span>restart<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">; </span>stop<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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/api.ts#L23">src/classes/api.ts:23</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initialize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> restart<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> stop<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="connections" class="tsd-anchor"></a>
<h3>connections</h3>
<div class="tsd-signature tsd-kind-icon">connections<span class="tsd-signature-symbol">:</span> <a href="../interfaces/connectionsapi.html" class="tsd-signature-type">ConnectionsApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L30">src/classes/api.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="documentation" class="tsd-anchor"></a>
<h3>documentation</h3>
<div class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">:</span> <a href="../interfaces/documentationapi.html" class="tsd-signature-type">DocumentationApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L36">src/classes/api.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="exceptionhandlers" class="tsd-anchor"></a>
<h3>exception<wbr>Handlers</h3>
<div class="tsd-signature tsd-kind-icon">exception<wbr>Handlers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/exceptionhandlerapi.html" class="tsd-signature-type">ExceptionHandlerAPI</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L41">src/classes/api.ts:41</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> <a href="../interfaces/paramsapi.html" class="tsd-signature-type">ParamsApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L35">src/classes/api.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="process" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> process</h3>
<div class="tsd-signature tsd-kind-icon">process<span class="tsd-signature-symbol">:</span> <a href="process.html" class="tsd-signature-type">Process</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L21">src/classes/api.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="redis" class="tsd-anchor"></a>
<h3>redis</h3>
<div class="tsd-signature tsd-kind-icon">redis<span class="tsd-signature-symbol">:</span> <a href="../interfaces/redisapi.html" class="tsd-signature-type">RedisApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L38">src/classes/api.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="resque" class="tsd-anchor"></a>
<h3>resque</h3>
<div class="tsd-signature tsd-kind-icon">resque<span class="tsd-signature-symbol">:</span> <a href="../interfaces/resqueapi.html" class="tsd-signature-type">ResqueApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L39">src/classes/api.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="routes" class="tsd-anchor"></a>
<h3>routes</h3>
<div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <a href="../interfaces/routesapi.html" class="tsd-signature-type">RoutesApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L40">src/classes/api.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="running" class="tsd-anchor"></a>
<h3>running</h3>
<div class="tsd-signature tsd-kind-icon">running<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/api.ts#L18">src/classes/api.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="servers" class="tsd-anchor"></a>
<h3>servers</h3>
<div class="tsd-signature tsd-kind-icon">servers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/serversapi.html" class="tsd-signature-type">ServersApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L33">src/classes/api.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="spechelper" class="tsd-anchor"></a>
<h3>spec<wbr>Helper</h3>
<div class="tsd-signature tsd-kind-icon">spec<wbr>Helper<span class="tsd-signature-symbol">:</span> <a href="../interfaces/spechelperapi.html" class="tsd-signature-type">SpecHelperApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L42">src/classes/api.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="staticfile" class="tsd-anchor"></a>
<h3>static<wbr>File</h3>
<div class="tsd-signature tsd-kind-icon">static<wbr>File<span class="tsd-signature-symbol">:</span> <a href="../interfaces/staticfileapi.html" class="tsd-signature-type">StaticFileApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L37">src/classes/api.ts:37</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="tasks" class="tsd-anchor"></a>
<h3>tasks</h3>
<div class="tsd-signature tsd-kind-icon">tasks<span class="tsd-signature-symbol">:</span> <a href="../interfaces/taskapi.html" class="tsd-signature-type">TaskApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/api.ts#L32">src/classes/api.ts:32</a></li>
</ul>
</aside>
</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="api.html" class="tsd-kind-icon">Api</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="api.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#actions" class="tsd-kind-icon">actions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#boottime" class="tsd-kind-icon">boot<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#chatroom" class="tsd-kind-icon">chat<wbr>Room</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#commands" class="tsd-kind-icon">commands</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#connections" class="tsd-kind-icon">connections</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#documentation" class="tsd-kind-icon">documentation</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#exceptionhandlers" class="tsd-kind-icon">exception<wbr>Handlers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#process" class="tsd-kind-icon">process</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#redis" class="tsd-kind-icon">redis</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#resque" class="tsd-kind-icon">resque</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#routes" class="tsd-kind-icon">routes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#running" class="tsd-kind-icon">running</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#servers" class="tsd-kind-icon">servers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#spechelper" class="tsd-kind-icon">spec<wbr>Helper</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#staticfile" class="tsd-kind-icon">static<wbr>File</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="api.html#tasks" class="tsd-kind-icon">tasks</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>