actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
325 lines • 17 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ResqueApi | 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="resqueapi.html">ResqueApi</a>
</li>
</ul>
<h1>Interface ResqueApi</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">ResqueApi</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#connectiondetails" class="tsd-kind-icon">connection<wbr>Details</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#multiworker" class="tsd-kind-icon">multi<wbr>Worker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#queue" class="tsd-kind-icon">queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#scheduler" class="tsd-kind-icon">scheduler</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#schedulerlogging" class="tsd-kind-icon">scheduler<wbr>Logging</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#startmultiworker" class="tsd-kind-icon">start<wbr>Multi<wbr>Worker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#startqueue" class="tsd-kind-icon">start<wbr>Queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#startscheduler" class="tsd-kind-icon">start<wbr>Scheduler</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#stopmultiworker" class="tsd-kind-icon">stop<wbr>Multi<wbr>Worker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#stopqueue" class="tsd-kind-icon">stop<wbr>Queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#stopscheduler" class="tsd-kind-icon">stop<wbr>Scheduler</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="resqueapi.html#workerlogging" class="tsd-kind-icon">worker<wbr>Logging</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="connectiondetails" class="tsd-anchor"></a>
<h3>connection<wbr>Details</h3>
<div class="tsd-signature tsd-kind-icon">connection<wbr>Details<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/initializers/resque.ts#L5">src/initializers/resque.ts:5</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-interface">
<a name="multiworker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> multi<wbr>Worker</h3>
<div class="tsd-signature tsd-kind-icon">multi<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MultiWorker</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L10">src/initializers/resque.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="queue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> queue</h3>
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Queue</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L8">src/initializers/resque.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="scheduler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> scheduler</h3>
<div class="tsd-signature tsd-kind-icon">scheduler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Scheduler</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L9">src/initializers/resque.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="schedulerlogging" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> scheduler<wbr>Logging</h3>
<div class="tsd-signature tsd-kind-icon">scheduler<wbr>Logging<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/initializers/resque.ts#L18">src/initializers/resque.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="startmultiworker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>Multi<wbr>Worker</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Multi<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L15">src/initializers/resque.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="startqueue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>Queue</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L11">src/initializers/resque.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="startscheduler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>Scheduler</h3>
<div class="tsd-signature tsd-kind-icon">start<wbr>Scheduler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L13">src/initializers/resque.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stopmultiworker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stop<wbr>Multi<wbr>Worker</h3>
<div class="tsd-signature tsd-kind-icon">stop<wbr>Multi<wbr>Worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L16">src/initializers/resque.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stopqueue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stop<wbr>Queue</h3>
<div class="tsd-signature tsd-kind-icon">stop<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L12">src/initializers/resque.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stopscheduler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stop<wbr>Scheduler</h3>
<div class="tsd-signature tsd-kind-icon">stop<wbr>Scheduler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/resque.ts#L14">src/initializers/resque.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="workerlogging" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> worker<wbr>Logging</h3>
<div class="tsd-signature tsd-kind-icon">worker<wbr>Logging<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/initializers/resque.ts#L17">src/initializers/resque.ts:17</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-interface">
<a href="resqueapi.html" class="tsd-kind-icon">Resque<wbr>Api</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#connectiondetails" class="tsd-kind-icon">connection<wbr>Details</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#multiworker" class="tsd-kind-icon">multi<wbr>Worker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#queue" class="tsd-kind-icon">queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#scheduler" class="tsd-kind-icon">scheduler</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#schedulerlogging" class="tsd-kind-icon">scheduler<wbr>Logging</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#startmultiworker" class="tsd-kind-icon">start<wbr>Multi<wbr>Worker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#startqueue" class="tsd-kind-icon">start<wbr>Queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#startscheduler" class="tsd-kind-icon">start<wbr>Scheduler</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#stopmultiworker" class="tsd-kind-icon">stop<wbr>Multi<wbr>Worker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#stopqueue" class="tsd-kind-icon">stop<wbr>Queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#stopscheduler" class="tsd-kind-icon">stop<wbr>Scheduler</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="resqueapi.html#workerlogging" class="tsd-kind-icon">worker<wbr>Logging</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>