actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
661 lines • 268 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>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>
</ul>
<h1>actionhero</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>Namespaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-namespace"><a href="modules/action.html" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-namespace"><a href="modules/cache.html" class="tsd-kind-icon">cache</a></li>
<li class="tsd-kind-namespace"><a href="modules/chatroom.html" class="tsd-kind-icon">chat<wbr>Room</a></li>
<li class="tsd-kind-namespace"><a href="modules/i18n.html" class="tsd-kind-icon">i18n</a></li>
<li class="tsd-kind-namespace"><a href="modules/redis.html" class="tsd-kind-icon">redis</a></li>
<li class="tsd-kind-namespace"><a href="modules/route.html" class="tsd-kind-icon">route</a></li>
<li class="tsd-kind-namespace"><a href="modules/spechelper.html" class="tsd-kind-icon">spec<wbr>Helper</a></li>
<li class="tsd-kind-namespace"><a href="modules/task.html" class="tsd-kind-icon">task</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/action.html" class="tsd-kind-icon">Action</a></li>
<li class="tsd-kind-class"><a href="classes/actionprocessor.html" class="tsd-kind-icon">Action<wbr>Processor</a></li>
<li class="tsd-kind-class"><a href="classes/actions.html" class="tsd-kind-icon">Actions</a></li>
<li class="tsd-kind-class"><a href="classes/actionslist.html" class="tsd-kind-icon">Actions<wbr>List</a></li>
<li class="tsd-kind-class"><a href="classes/api.html" class="tsd-kind-icon">Api</a></li>
<li class="tsd-kind-class"><a href="classes/cli.html" class="tsd-kind-icon">CLI</a></li>
<li class="tsd-kind-class"><a href="classes/cachetest.html" class="tsd-kind-icon">Cache<wbr>Test</a></li>
<li class="tsd-kind-class"><a href="classes/chatroom.html" class="tsd-kind-icon">Chat<wbr>Room</a></li>
<li class="tsd-kind-class"><a href="classes/connection.html" class="tsd-kind-icon">Connection</a></li>
<li class="tsd-kind-class"><a href="classes/connections.html" class="tsd-kind-icon">Connections</a></li>
<li class="tsd-kind-class"><a href="classes/console.html" class="tsd-kind-icon">Console</a></li>
<li class="tsd-kind-class"><a href="classes/createchatroom.html" class="tsd-kind-icon">Create<wbr>Chat<wbr>Room</a></li>
<li class="tsd-kind-class"><a href="classes/documentation.html" class="tsd-kind-icon">Documentation</a></li>
<li class="tsd-kind-class"><a href="classes/exceptions.html" class="tsd-kind-icon">Exceptions</a></li>
<li class="tsd-kind-class"><a href="classes/generate.html" class="tsd-kind-icon">Generate</a></li>
<li class="tsd-kind-class"><a href="classes/generateaction.html" class="tsd-kind-icon">Generate<wbr>Action</a></li>
<li class="tsd-kind-class"><a href="classes/generatecli.html" class="tsd-kind-icon">GenerateCLI</a></li>
<li class="tsd-kind-class"><a href="classes/generateinitializer.html" class="tsd-kind-icon">Generate<wbr>Initializer</a></li>
<li class="tsd-kind-class"><a href="classes/generateplugin.html" class="tsd-kind-icon">Generate<wbr>Plugin</a></li>
<li class="tsd-kind-class"><a href="classes/generateserver.html" class="tsd-kind-icon">Generate<wbr>Server</a></li>
<li class="tsd-kind-class"><a href="classes/generatetask.html" class="tsd-kind-icon">Generate<wbr>Task</a></li>
<li class="tsd-kind-class"><a href="classes/help.html" class="tsd-kind-icon">Help</a></li>
<li class="tsd-kind-class"><a href="classes/initializer.html" class="tsd-kind-icon">Initializer</a></li>
<li class="tsd-kind-class"><a href="classes/params.html" class="tsd-kind-icon">Params</a></li>
<li class="tsd-kind-class"><a href="classes/polyfill.html" class="tsd-kind-icon">Polyfill</a></li>
<li class="tsd-kind-class"><a href="classes/process.html" class="tsd-kind-icon">Process</a></li>
<li class="tsd-kind-class"><a href="classes/randomnumber.html" class="tsd-kind-icon">Random<wbr>Number</a></li>
<li class="tsd-kind-class"><a href="classes/redis.html" class="tsd-kind-icon">Redis</a></li>
<li class="tsd-kind-class"><a href="classes/resque.html" class="tsd-kind-icon">Resque</a></li>
<li class="tsd-kind-class"><a href="classes/routes.html" class="tsd-kind-icon">Routes</a></li>
<li class="tsd-kind-class"><a href="classes/runaction.html" class="tsd-kind-icon">Run<wbr>Action</a></li>
<li class="tsd-kind-class"><a href="classes/server.html" class="tsd-kind-icon">Server</a></li>
<li class="tsd-kind-class"><a href="classes/servers.html" class="tsd-kind-icon">Servers</a></li>
<li class="tsd-kind-class"><a href="classes/showdocumentation.html" class="tsd-kind-icon">Show<wbr>Documentation</a></li>
<li class="tsd-kind-class"><a href="classes/sleeptest.html" class="tsd-kind-icon">Sleep<wbr>Test</a></li>
<li class="tsd-kind-class"><a href="classes/spechelper.html" class="tsd-kind-icon">Spec<wbr>Helper</a></li>
<li class="tsd-kind-class"><a href="classes/staticfile.html" class="tsd-kind-icon">Static<wbr>File</a></li>
<li class="tsd-kind-class"><a href="classes/task.html" class="tsd-kind-icon">Task</a></li>
<li class="tsd-kind-class"><a href="classes/taskenqueue.html" class="tsd-kind-icon">Task<wbr>Enqueue</a></li>
<li class="tsd-kind-class"><a href="classes/tasks.html" class="tsd-kind-icon">Tasks</a></li>
<li class="tsd-kind-class"><a href="classes/validationtest.html" class="tsd-kind-icon">Validation<wbr>Test</a></li>
<li class="tsd-kind-class"><a href="classes/version.html" class="tsd-kind-icon">Version</a></li>
<li class="tsd-kind-class"><a href="classes/webserver.html" class="tsd-kind-icon">Web<wbr>Server</a></li>
<li class="tsd-kind-class"><a href="classes/websocketserver.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Server</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/actionsapi.html" class="tsd-kind-icon">Actions<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/chatroomapi.html" class="tsd-kind-icon">Chat<wbr>Room<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/configinterface.html" class="tsd-kind-icon">Config<wbr>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/connectionmiddleware.html" class="tsd-kind-icon">Connection<wbr>Middleware</a></li>
<li class="tsd-kind-interface"><a href="interfaces/connectionparams.html" class="tsd-kind-icon">Connection<wbr>Params</a></li>
<li class="tsd-kind-interface"><a href="interfaces/connectionsapi.html" class="tsd-kind-icon">Connections<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/documentationapi.html" class="tsd-kind-icon">Documentation<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/exceptionhandlerapi.html" class="tsd-kind-icon">Exception<wbr>HandlerAPI</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initializers.html" class="tsd-kind-icon">Initializers</a></li>
<li class="tsd-kind-interface"><a href="interfaces/input.html" class="tsd-kind-icon">Input</a></li>
<li class="tsd-kind-interface"><a href="interfaces/inputs.html" class="tsd-kind-icon">Inputs</a></li>
<li class="tsd-kind-interface"><a href="interfaces/paramsapi.html" class="tsd-kind-icon">Params<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/redisapi.html" class="tsd-kind-icon">Redis<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/resqueapi.html" class="tsd-kind-icon">Resque<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/routesapi.html" class="tsd-kind-icon">Routes<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/runner.html" class="tsd-kind-icon">Runner</a></li>
<li class="tsd-kind-interface"><a href="interfaces/runnerinputs.html" class="tsd-kind-icon">Runner<wbr>Inputs</a></li>
<li class="tsd-kind-interface"><a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a></li>
<li class="tsd-kind-interface"><a href="interfaces/serversapi.html" class="tsd-kind-icon">Servers<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/spechelperapi.html" class="tsd-kind-icon">Spec<wbr>Helper<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/staticfileapi.html" class="tsd-kind-icon">Static<wbr>File<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/taskapi.html" class="tsd-kind-icon">Task<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/taskdata.html" class="tsd-kind-icon">Task<wbr>Data</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="globals.html#packagejson" class="tsd-kind-icon">PackageJSON</a></li>
<li class="tsd-kind-variable"><a href="globals.html#actionheroversion" class="tsd-kind-icon">actionhero<wbr>Version</a></li>
<li class="tsd-kind-variable"><a href="globals.html#api" class="tsd-kind-icon">api</a></li>
<li class="tsd-kind-variable"><a href="globals.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-variable"><a href="globals.html#configpaths" class="tsd-kind-icon">config<wbr>Paths</a></li>
<li class="tsd-kind-variable"><a href="globals.html#db" class="tsd-kind-icon">db</a></li>
<li class="tsd-kind-variable"><a href="globals.html#env" class="tsd-kind-icon">env</a></li>
<li class="tsd-kind-variable"><a href="globals.html#host" class="tsd-kind-icon">host</a></li>
<li class="tsd-kind-variable"><a href="globals.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-variable"><a href="globals.html#loggers" class="tsd-kind-icon">loggers</a></li>
<li class="tsd-kind-variable"><a href="globals.html#maxbackoff" class="tsd-kind-icon">max<wbr>Backoff</a></li>
<li class="tsd-kind-variable"><a href="globals.html#maxeventloopdelay" class="tsd-kind-icon">max<wbr>Event<wbr>Loop<wbr>Delay</a></li>
<li class="tsd-kind-variable"><a href="globals.html#maxmemoryalloted" class="tsd-kind-icon">max<wbr>Memory<wbr>Alloted</a></li>
<li class="tsd-kind-variable"><a href="globals.html#maxresquequeuelength" class="tsd-kind-icon">max<wbr>Resque<wbr>Queue<wbr>Length</a></li>
<li class="tsd-kind-variable"><a href="globals.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-variable"><a href="globals.html#os" class="tsd-kind-icon">os</a></li>
<li class="tsd-kind-variable"><a href="globals.html#packagejson" class="tsd-kind-icon">packageJSON</a></li>
<li class="tsd-kind-variable"><a href="globals.html#packagejson" class="tsd-kind-icon">package<wbr>Json</a></li>
<li class="tsd-kind-variable"><a href="globals.html#password" class="tsd-kind-icon">password</a></li>
<li class="tsd-kind-variable"><a href="globals.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-variable"><a href="globals.html#pid" class="tsd-kind-icon">pid</a></li>
<li class="tsd-kind-variable"><a href="globals.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-variable"><a href="globals.html#projectroot" class="tsd-kind-icon">project<wbr>Root</a></li>
<li class="tsd-kind-variable"><a href="globals.html#taskmodule" class="tsd-kind-icon">task<wbr>Module</a></li>
<li class="tsd-kind-variable"><a href="globals.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-variable"><a href="globals.html#typescript" class="tsd-kind-icon">typescript</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="globals.html#arraystartingmatch" class="tsd-kind-icon">array<wbr>Starting<wbr>Match</a></li>
<li class="tsd-kind-function"><a href="globals.html#arrayunique" class="tsd-kind-icon">array<wbr>Unique</a></li>
<li class="tsd-kind-function"><a href="globals.html#asyncreadlink" class="tsd-kind-icon">async<wbr>Read<wbr>Link</a></li>
<li class="tsd-kind-function"><a href="globals.html#asyncstats" class="tsd-kind-icon">async<wbr>Stats</a></li>
<li class="tsd-kind-function"><a href="globals.html#asyncwaterfall" class="tsd-kind-icon">async<wbr>Waterfall</a></li>
<li class="tsd-kind-function"><a href="globals.html#buildconfig" class="tsd-kind-icon">build<wbr>Config</a></li>
<li class="tsd-kind-function"><a href="globals.html#buildconsolelogger" class="tsd-kind-icon">build<wbr>Console<wbr>Logger</a></li>
<li class="tsd-kind-function"><a href="globals.html#buildfilelogger" class="tsd-kind-icon">build<wbr>File<wbr>Logger</a></li>
<li class="tsd-kind-function"><a href="globals.html#clearpidfile" class="tsd-kind-icon">clear<wbr>Pid<wbr>File</a></li>
<li class="tsd-kind-function"><a href="globals.html#collapseobjecttoarray" class="tsd-kind-icon">collapse<wbr>Object<wbr>ToArray</a></li>
<li class="tsd-kind-function"><a href="globals.html#createdirsafely" class="tsd-kind-icon">create<wbr>Dir<wbr>Safely</a></li>
<li class="tsd-kind-function"><a href="globals.html#createfilesafely" class="tsd-kind-icon">create<wbr>File<wbr>Safely</a></li>
<li class="tsd-kind-function"><a href="globals.html#createlinkfilesafely" class="tsd-kind-icon">create<wbr>Linkfile<wbr>Safely</a></li>
<li class="tsd-kind-function"><a href="globals.html#createsymlinksafely" class="tsd-kind-icon">create<wbr>Symlink<wbr>Safely</a></li>
<li class="tsd-kind-function"><a href="globals.html#determineid" class="tsd-kind-icon">determine<wbr>Id</a></li>
<li class="tsd-kind-function"><a href="globals.html#determinenodeenv" class="tsd-kind-icon">determine<wbr>Node<wbr>Env</a></li>
<li class="tsd-kind-function"><a href="globals.html#determineprojectroot" class="tsd-kind-icon">determine<wbr>Project<wbr>Root</a></li>
<li class="tsd-kind-function"><a href="globals.html#direxists" class="tsd-kind-icon">dir<wbr>Exists</a></li>
<li class="tsd-kind-function"><a href="globals.html#ensurenotsheaderfiles" class="tsd-kind-icon">ensure<wbr>NoTs<wbr>Header<wbr>Files</a></li>
<li class="tsd-kind-function"><a href="globals.html#eventloopdelay" class="tsd-kind-icon">event<wbr>Loop<wbr>Delay</a></li>
<li class="tsd-kind-function"><a href="globals.html#fileexists" class="tsd-kind-icon">file<wbr>Exists</a></li>
<li class="tsd-kind-function"><a href="globals.html#filterobjectforlogging" class="tsd-kind-icon">filter<wbr>Object<wbr>For<wbr>Logging</a></li>
<li class="tsd-kind-function"><a href="globals.html#getexternalipaddress" class="tsd-kind-icon">get<wbr>ExternalIPAddress</a></li>
<li class="tsd-kind-function"><a href="globals.html#hashmerge" class="tsd-kind-icon">hash<wbr>Merge</a></li>
<li class="tsd-kind-function"><a href="globals.html#isplainobject" class="tsd-kind-icon">is<wbr>Plain<wbr>Object</a></li>
<li class="tsd-kind-function"><a href="globals.html#istypescript" class="tsd-kind-icon">is<wbr>Typescript</a></li>
<li class="tsd-kind-function"><a href="globals.html#log" class="tsd-kind-icon">log</a></li>
<li class="tsd-kind-function"><a href="globals.html#main" class="tsd-kind-icon">main</a></li>
<li class="tsd-kind-function"><a href="globals.html#parsecookies" class="tsd-kind-icon">parse<wbr>Cookies</a></li>
<li class="tsd-kind-function"><a href="globals.html#parseheadersforclientaddress" class="tsd-kind-icon">parse<wbr>Headers<wbr>For<wbr>Client<wbr>Address</a></li>
<li class="tsd-kind-function"><a href="globals.html#parseipv6uri" class="tsd-kind-icon">parseIPv6URI</a></li>
<li class="tsd-kind-function"><a href="globals.html#removelinkfilesafely" class="tsd-kind-icon">remove<wbr>Linkfile<wbr>Safely</a></li>
<li class="tsd-kind-function"><a href="globals.html#replacedistwithsrc" class="tsd-kind-icon">replace<wbr>Dist<wbr>With<wbr>Src</a></li>
<li class="tsd-kind-function"><a href="globals.html#sanitizeid" class="tsd-kind-icon">sanitize<wbr>Id</a></li>
<li class="tsd-kind-function"><a href="globals.html#sleep" class="tsd-kind-icon">sleep</a></li>
<li class="tsd-kind-function"><a href="globals.html#sortglobalmiddleware" class="tsd-kind-icon">sort<wbr>Global<wbr>Middleware</a></li>
<li class="tsd-kind-function"><a href="globals.html#sortnumber" class="tsd-kind-icon">sort<wbr>Number</a></li>
<li class="tsd-kind-function"><a href="globals.html#sourcerelativelinkpath" class="tsd-kind-icon">source<wbr>Relative<wbr>Link<wbr>Path</a></li>
<li class="tsd-kind-function"><a href="globals.html#stringifyextramessagepropertiesforconsole" class="tsd-kind-icon">stringify<wbr>Extra<wbr>Message<wbr>Properties<wbr>For<wbr>Console</a></li>
<li class="tsd-kind-function"><a href="globals.html#writepidfile" class="tsd-kind-icon">write<wbr>Pid<wbr>File</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal"><a href="globals.html#default" class="tsd-kind-icon">DEFAULT</a></li>
<li class="tsd-kind-object-literal"><a href="globals.html#production" class="tsd-kind-icon">production</a></li>
<li class="tsd-kind-object-literal"><a href="globals.html#test" class="tsd-kind-icon">test</a></li>
<li class="tsd-kind-object-literal"><a href="globals.html#utils" class="tsd-kind-icon">utils</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="packagejson" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> PackageJSON</h3>
<div class="tsd-signature tsd-kind-icon">PackageJSON<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require(path.join(__dirname,"..","..","..","package.json"))</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/bin/methods/generate/plugin.ts#L5">src/bin/methods/generate/plugin.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="actionheroversion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> actionhero<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">actionhero<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = packageJson.version</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/actionheroVersion.ts#L11">src/classes/process/actionheroVersion.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="api" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> api</h3>
<div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <a href="classes/api.html" class="tsd-signature-type">Api</a><span class="tsd-signature-symbol"> = global.api</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/index.ts#L44">src/index.ts:44</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="config" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="interfaces/configinterface.html" class="tsd-signature-type">ConfigInterface</a><span class="tsd-signature-symbol"> = buildConfig()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/modules/config.ts#L206">src/modules/config.ts:206</a></li>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process.ts#L17">src/classes/process.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="configpaths" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> config<wbr>Paths</h3>
<div class="tsd-signature tsd-kind-icon">config<wbr>Paths<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/modules/config.ts#L17">src/modules/config.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="db" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> db</h3>
<div class="tsd-signature tsd-kind-icon">db<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.env.REDIS_DB || process.env.JEST_WORKER_ID || "0"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/redis.ts#L5">src/config/redis.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="env" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> env</h3>
<div class="tsd-signature tsd-kind-icon">env<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = determineNodeEnv()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/env.ts#L15">src/classes/process/env.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="host" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> host</h3>
<div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.env.REDIS_HOST || "127.0.0.1"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/redis.ts#L3">src/config/redis.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = determineId()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/id.ts#L38">src/classes/process/id.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="loggers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> loggers</h3>
<div class="tsd-signature tsd-kind-icon">loggers<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/modules/log.ts#L5">src/modules/log.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="maxbackoff" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> max<wbr>Backoff</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Backoff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1000</span><span class="tsd-signature-symbol"> = 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/redis.ts#L7">src/config/redis.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="maxeventloopdelay" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> max<wbr>Event<wbr>Loop<wbr>Delay</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Event<wbr>Loop<wbr>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">10</span><span class="tsd-signature-symbol"> = process.env.eventLoopDelay || 10</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/actions/status.ts#L8">src/actions/status.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="maxmemoryalloted" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> max<wbr>Memory<wbr>Alloted</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Memory<wbr>Alloted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">500</span><span class="tsd-signature-symbol"> = process.env.maxMemoryAlloted || 500</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/actions/status.ts#L9">src/actions/status.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="maxresquequeuelength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> max<wbr>Resque<wbr>Queue<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Resque<wbr>Queue<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1000</span><span class="tsd-signature-symbol"> = process.env.maxResqueQueueLength || 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/actions/status.ts#L10">src/actions/status.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="options" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = config.i18n</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/modules/i18n.ts#L8">src/modules/i18n.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="os" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> os</h3>
<div class="tsd-signature tsd-kind-icon">os<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("os")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/servers/web.ts#L1">src/config/servers/web.ts:1</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="packagejson" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> packageJSON</h3>
<div class="tsd-signature tsd-kind-icon">packageJSON<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require(path.join(__dirname, "/../../../package.json"))</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/actions/status.ts#L3">src/actions/status.ts:3</a></li>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/bin/methods/version.ts#L6">src/bin/methods/version.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="packagejson" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> package<wbr>Json</h3>
<div class="tsd-signature tsd-kind-icon">package<wbr>Json<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require(path.join(__dirname,"..","..","..","package.json"))</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/actionheroVersion.ts#L3">src/classes/process/actionheroVersion.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="password" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> password</h3>
<div class="tsd-signature tsd-kind-icon">password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = process.env.REDIS_PASSWORD || null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/redis.ts#L6">src/config/redis.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="path" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require("path")</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/pid.ts#L15">src/classes/process/pid.ts:15</a></li>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/api.ts#L1">src/config/api.ts:1</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="pid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> pid</h3>
<div class="tsd-signature tsd-kind-icon">pid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = process.pid</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/pid.ts#L14">src/classes/process/pid.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="port" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> port</h3>
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = process.env.REDIS_PORT || 6379</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/config/redis.ts#L4">src/config/redis.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="projectroot" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> project<wbr>Root</h3>
<div class="tsd-signature tsd-kind-icon">project<wbr>Root<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = determineProjectRoot()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/projectRoot.ts#L14">src/classes/process/projectRoot.ts:14</a></li>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/bin/actionhero.ts#L31">src/bin/actionhero.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="taskmodule" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> task<wbr>Module</h3>
<div class="tsd-signature tsd-kind-icon">task<wbr>Module<span class="tsd-signature-symbol">:</span> <a href="modules/task.html" class="tsd-signature-type">task</a><span class="tsd-signature-symbol"> = task</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/tasks.ts#L7">src/initializers/tasks.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="title" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `actionhero-${sanitizeId()}`</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/pid.ts#L16">src/classes/process/pid.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="typescript" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> typescript</h3>
<div class="tsd-signature tsd-kind-icon">typescript<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = isTypescript()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/process/typescript.ts#L33">src/classes/process/typescript.ts:33</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">
<a name="arraystartingmatch" class="tsd-anchor"></a>
<h3>array<wbr>Starting<wbr>Match</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">array<wbr>Starting<wbr>Match<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><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-symbol">: </span><span class="tsd-signature-type">boolean</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/modules/utils/arrayStartingMatch.ts#L4">src/modules/utils/arrayStartingMatch.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compare the first n elements of an array with another, longer array</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>b: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="arrayunique" class="tsd-anchor"></a>
<h3>array<wbr>Unique</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">array<wbr>Unique<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><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-symbol">: </span><span class="tsd-signature-type">Array</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/modules/utils/arrayUnique.ts#L4">src/modules/utils/arrayUnique.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return only the unique values in an Array.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>arr: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</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-function">
<a name="asyncreadlink" class="tsd-anchor"></a>
<h3>async<wbr>Read<wbr>Link</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">async<wbr>Read<wbr>Link<span class="tsd-signature-symbol">(</span>file<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">string</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/initializers/staticFile.ts#L18">src/initializers/staticFile.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>file: <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">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="asyncstats" class="tsd-anchor"></a>
<h3>async<wbr>Stats</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">async<wbr>Stats<span class="tsd-signature-symbol">(</span>file<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-symbol">{}</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/initializers/staticFile.ts#L7">src/initializers/staticFile.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>file: <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-symbol">{}</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="asyncwaterfall" class="tsd-anchor"></a>
<h3>async<wbr>Waterfall</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">async<wbr>Waterfall<span class="tsd-signature-symbol">(</span>jobs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Function</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">Array</span><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>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> }</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">Array</span><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></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/modules/utils/asyncWaterfall.ts#L30">src/modules/utils/asyncWaterfall.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>In series, run an array of <code>async</code> functions</p>
</div>
<p>without arguments</p>
<pre><code class="language-js"><span class="hljs-keyword">let</span> sleepyFunc = <span class="hljs-keyword">async</span> () => {
<span class="hljs-keyword">await</span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">Promise</span>(<span class="hljs-function">(<span class="hljs-params">resolve</span>) =></span> { setTimeout(resolve, <span class="hljs-number">100</span>) })
<span class="hljs-keyword">return</span> (<span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>()).getTime()
}
<span class="hljs-keyword">let</span> jobs = [sleepyFunc, sleepyFunc, sleepyFunc]
<span class="hljs-keyword">let</span> responses = <span class="hljs-keyword">await</span> api.utils.asyncWaterfall(jobs)
<span class="hljs-comment">// responses = [1506536188356, 1506536188456, 1506536188456]</span></code></pre>
<p>with arguments</p>
<pre><code class="language-js"><span class="hljs-keyword">let</span> sleepyFunc = <span class="hljs-keyword">async</span> (response) => {
<span class="hljs-keyword">await</span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">Promise</span>(<span class="hljs-function">(<span class="hljs-params">resolve</span>) =></span> { setTimeout(resolve, <span class="hljs-number">100</span>) })
<span class="hljs-keyword">return</span> response
}
<span class="hljs-keyword">let</span> jobs = [
{<span class="hljs-attr">method</span>: sleepyFunc, <span class="hljs-attr">args</span>: [<span class="hljs-string">'a'</span>]},
{<span class="hljs-attr">method</span>: sleepyFunc, <span class="hljs-attr">args</span>: [<span class="hljs-string">'b'</span>]},
{<span class="hljs-attr">method</span>: sleepyFunc, <span class="hljs-attr">args</span>: [<span class="hljs-string">'c'</span>]}
]
<span class="hljs-keyword">let</span> responses = <span class="hljs-keyword">await</span> api.utils.asyncWaterfall(jobs)
<span class="hljs-comment">// responses = ['a', 'b', 'c']</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class