docs/agenda/4.x/globals.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>@hokify/agenda</title>
<meta name="description" content="Documentation for @hokify/agenda">
<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">@hokify/agenda</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>@hokify/agenda</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/agenda.html" class="tsd-kind-icon">Agenda</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/job.html" class="tsd-kind-icon">Job</a></li>
<li class="tsd-kind-class"><a href="classes/jobdbrepository.html" class="tsd-kind-icon">Job<wbr>DbRepository</a></li>
<li class="tsd-kind-class"><a href="classes/jobprocessingqueue.html" class="tsd-kind-icon">Job<wbr>Processing<wbr>Queue</a></li>
<li class="tsd-kind-class"><a href="classes/jobprocessor.html" class="tsd-kind-icon">Job<wbr>Processor</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/iagendaconfig.html" class="tsd-kind-icon">IAgenda<wbr>Config</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iagendajobstatus.html" class="tsd-kind-icon">IAgenda<wbr>Job<wbr>Status</a></li>
<li class="tsd-kind-interface"><a href="interfaces/iagendastatus.html" class="tsd-kind-icon">IAgenda<wbr>Status</a></li>
<li class="tsd-kind-interface"><a href="interfaces/idatabaseoptions.html" class="tsd-kind-icon">IDatabase<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/idbconfig.html" class="tsd-kind-icon">IDb<wbr>Config</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ijobdefinition.html" class="tsd-kind-icon">IJob<wbr>Definition</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ijobparameters.html" class="tsd-kind-icon">IJob<wbr>Parameters</a></li>
<li class="tsd-kind-interface"><a href="interfaces/imongooptions.html" class="tsd-kind-icon">IMongo<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#definitionprocessor" class="tsd-kind-icon">Definition<wbr>Processor</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#jobpriority" class="tsd-kind-icon">Job<wbr>Priority</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#jobwithid" class="tsd-kind-icon">Job<wbr>With<wbr>Id</a></li>
<li class="tsd-kind-type-alias"><a href="globals.html#tjobdatefield" class="tsd-kind-icon">TJob<wbr>Datefield</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#agendaversion" class="tsd-kind-icon">agenda<wbr>Version</a></li>
<li class="tsd-kind-variable"><a href="globals.html#datefields" class="tsd-kind-icon">datefields</a></li>
<li class="tsd-kind-variable"><a href="globals.html#log" class="tsd-kind-icon">log</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#calculateprocessevery" class="tsd-kind-icon">calculate<wbr>Process<wbr>Every</a></li>
<li class="tsd-kind-function"><a href="globals.html#computefrominterval" class="tsd-kind-icon">compute<wbr>From<wbr>Interval</a></li>
<li class="tsd-kind-function"><a href="globals.html#computefromrepeatat" class="tsd-kind-icon">compute<wbr>From<wbr>Repeat<wbr>At</a></li>
<li class="tsd-kind-function"><a href="globals.html#datefortimezone" class="tsd-kind-icon">date<wbr>For<wbr>Timezone</a></li>
<li class="tsd-kind-function"><a href="globals.html#hasmongoprotocol" class="tsd-kind-icon">has<wbr>Mongo<wbr>Protocol</a></li>
<li class="tsd-kind-function"><a href="globals.html#isvaliddate" class="tsd-kind-icon">is<wbr>Valid<wbr>Date</a></li>
<li class="tsd-kind-function"><a href="globals.html#isvalidhumaninterval" class="tsd-kind-icon">is<wbr>Valid<wbr>Human<wbr>Interval</a></li>
<li class="tsd-kind-function"><a href="globals.html#parsepriority" class="tsd-kind-icon">parse<wbr>Priority</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#prioritymap" class="tsd-kind-icon">priority<wbr>Map</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
<a name="definitionprocessor" class="tsd-anchor"></a>
<h3>Definition<wbr>Processor</h3>
<div class="tsd-signature tsd-kind-icon">Definition<wbr>Processor<DATA, CB><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>agendaJob<span class="tsd-signature-symbol">: </span><a href="classes/job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DATA</span><span class="tsd-signature-symbol">></span>, done<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CB</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">CB</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobDefinition.ts#L16">src/types/JobDefinition.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>DATA</h4>
</li>
<li>
<h4>CB</h4>
</li>
</ul>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>agendaJob<span class="tsd-signature-symbol">: </span><a href="classes/job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DATA</span><span class="tsd-signature-symbol">></span>, done<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CB</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CB</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>agendaJob: <a href="classes/job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DATA</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>done: <span class="tsd-signature-type">CB</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CB</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="jobpriority" class="tsd-anchor"></a>
<h3>Job<wbr>Priority</h3>
<div class="tsd-signature tsd-kind-icon">Job<wbr>Priority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="globals.html#prioritymap" class="tsd-signature-type">priorityMap</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L1">src/utils/priority.ts:1</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="jobwithid" class="tsd-anchor"></a>
<h3>Job<wbr>With<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">Job<wbr>With<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="classes/job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>attrs<span class="tsd-signature-symbol">: </span><a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ObjectId</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/hokify/agenda/blob/bd6157a/src/Job.ts#L390">src/Job.ts:390</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="tjobdatefield" class="tsd-anchor"></a>
<h3>TJob<wbr>Datefield</h3>
<div class="tsd-signature tsd-kind-icon">TJob<wbr>Datefield<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"lastRunAt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lastFinishedAt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"nextRunAt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"failedAt"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lockedAt"</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobParameters.ts#L37">src/types/JobParameters.ts:37</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="agendaversion" class="tsd-anchor"></a>
<h3>agenda<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">agenda<wbr>Version<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/hokify/agenda/blob/bd6157a/src/JobProcessor.ts#L12">src/JobProcessor.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="datefields" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> datefields</h3>
<div class="tsd-signature tsd-kind-icon">datefields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="globals.html#tjobdatefield" class="tsd-signature-type">TJobDatefield</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ['lastRunAt','lastFinishedAt','nextRunAt','failedAt','lockedAt']</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobParameters.ts#L42">src/types/JobParameters.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="log" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> log</h3>
<div class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Debugger</span><span class="tsd-signature-symbol"> = debug('agenda:job')</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/JobDbRepository.ts#L19">src/JobDbRepository.ts:19</a></li>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/JobProcessor.ts#L9">src/JobProcessor.ts:9</a></li>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/index.ts#L16">src/index.ts:16</a></li>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/nextRunAt.ts#L9">src/utils/nextRunAt.ts:9</a></li>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/Job.ts#L10">src/Job.ts:10</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="calculateprocessevery" class="tsd-anchor"></a>
<h3>calculate<wbr>Process<wbr>Every</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">calculate<wbr>Process<wbr>Every<span class="tsd-signature-symbol">(</span>input<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><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/hokify/agenda/blob/bd6157a/src/utils/processEvery.ts#L3">src/utils/processEvery.ts:3</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> input: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 5000</span></h5>
</li>
</ul>
<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-function">
<a name="computefrominterval" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>From<wbr>Interval</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">compute<wbr>From<wbr>Interval<span class="tsd-signature-symbol">(</span>attrs<span class="tsd-signature-symbol">: </span><a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/nextRunAt.ts#L28">src/utils/nextRunAt.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Internal method that computes the interval</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>attrs: <a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="computefromrepeatat" class="tsd-anchor"></a>
<h3>compute<wbr>From<wbr>Repeat<wbr>At</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">compute<wbr>From<wbr>Repeat<wbr>At<span class="tsd-signature-symbol">(</span>attrs<span class="tsd-signature-symbol">: </span><a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/nextRunAt.ts#L79">src/utils/nextRunAt.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Internal method to compute next run time from the repeat string</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>attrs: <a href="interfaces/ijobparameters.html" class="tsd-signature-type">IJobParameters</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="datefortimezone" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> date<wbr>For<wbr>Timezone</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">date<wbr>For<wbr>Timezone<span class="tsd-signature-symbol">(</span>timezoneDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span>, timezone<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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">Moment</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/nextRunAt.ts#L11">src/utils/nextRunAt.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>timezoneDate: <span class="tsd-signature-type">Date</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> timezone: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="hasmongoprotocol" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> has<wbr>Mongo<wbr>Protocol</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">has<wbr>Mongo<wbr>Protocol<span class="tsd-signature-symbol">(</span>url<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">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/hokify/agenda/blob/bd6157a/src/utils/hasMongoProtocol.ts#L1">src/utils/hasMongoProtocol.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</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="isvaliddate" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Date</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Date<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">date</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Date</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/isValidDate.ts#L1">src/utils/isValidDate.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>date: <span class="tsd-signature-type">unknown</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">date</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Date</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="isvalidhumaninterval" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Human<wbr>Interval</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Human<wbr>Interval<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/nextRunAt.ts#L20">src/utils/nextRunAt.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">unknown</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="parsepriority" class="tsd-anchor"></a>
<h3>parse<wbr>Priority</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Priority<span class="tsd-signature-symbol">(</span>priority<span class="tsd-signature-symbol">?: </span><a href="globals.html#jobpriority" class="tsd-signature-type">JobPriority</a><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/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L14">src/utils/priority.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Internal method to turn priority into a number</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <a href="globals.html#jobpriority" class="tsd-signature-type">JobPriority</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal">
<a name="prioritymap" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> priority<wbr>Map</h3>
<div class="tsd-signature tsd-kind-icon">priority<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L3">src/utils/priority.ts:3</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="prioritymap.high" class="tsd-anchor"></a>
<h3>high</h3>
<div class="tsd-signature tsd-kind-icon">high<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L7">src/utils/priority.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="prioritymap.highest" class="tsd-anchor"></a>
<h3>highest</h3>
<div class="tsd-signature tsd-kind-icon">highest<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 20</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L8">src/utils/priority.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="prioritymap.low" class="tsd-anchor"></a>
<h3>low</h3>
<div class="tsd-signature tsd-kind-icon">low<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -10</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L5">src/utils/priority.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="prioritymap.lowest" class="tsd-anchor"></a>
<h3>lowest</h3>
<div class="tsd-signature tsd-kind-icon">lowest<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -20</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L4">src/utils/priority.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="prioritymap.normal" class="tsd-anchor"></a>
<h3>normal</h3>
<div class="tsd-signature tsd-kind-icon">normal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/utils/priority.ts#L6">src/utils/priority.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals current ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/agenda.html" class="tsd-kind-icon">Agenda</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/job.html" class="tsd-kind-icon">Job</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/jobdbrepository.html" class="tsd-kind-icon">Job<wbr>DbRepository</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/jobprocessingqueue.html" class="tsd-kind-icon">Job<wbr>Processing<wbr>Queue</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/jobprocessor.html" class="tsd-kind-icon">Job<wbr>Processor</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iagendaconfig.html" class="tsd-kind-icon">IAgenda<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iagendajobstatus.html" class="tsd-kind-icon">IAgenda<wbr>Job<wbr>Status</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/iagendastatus.html" class="tsd-kind-icon">IAgenda<wbr>Status</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/idatabaseoptions.html" class="tsd-kind-icon">IDatabase<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/idbconfig.html" class="tsd-kind-icon">IDb<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/ijobdefinition.html" class="tsd-kind-icon">IJob<wbr>Definition</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/ijobparameters.html" class="tsd-kind-icon">IJob<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/imongooptions.html" class="tsd-kind-icon">IMongo<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="globals.html#definitionprocessor" class="tsd-kind-icon">Definition<wbr>Processor</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#jobpriority" class="tsd-kind-icon">Job<wbr>Priority</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#jobwithid" class="tsd-kind-icon">Job<wbr>With<wbr>Id</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#tjobdatefield" class="tsd-kind-icon">TJob<wbr>Datefield</a>
</li>
<li class=" tsd-kind-variable">
<a href="globals.html#agendaversion" class="tsd-kind-icon">agenda<wbr>Version</a>
</li>
<li class=" tsd-kind-variable">
<a href="globals.html#datefields" class="tsd-kind-icon">datefields</a>
</li>
<li class=" tsd-kind-variable">
<a href="globals.html#log" class="tsd-kind-icon">log</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#calculateprocessevery" class="tsd-kind-icon">calculate<wbr>Process<wbr>Every</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#computefrominterval" class="tsd-kind-icon">compute<wbr>From<wbr>Interval</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#computefromrepeatat" class="tsd-kind-icon">compute<wbr>From<wbr>Repeat<wbr>At</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#datefortimezone" class="tsd-kind-icon">date<wbr>For<wbr>Timezone</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#hasmongoprotocol" class="tsd-kind-icon">has<wbr>Mongo<wbr>Protocol</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#isvaliddate" class="tsd-kind-icon">is<wbr>Valid<wbr>Date</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#isvalidhumaninterval" class="tsd-kind-icon">is<wbr>Valid<wbr>Human<wbr>Interval</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#parsepriority" class="tsd-kind-icon">parse<wbr>Priority</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#prioritymap" class="tsd-kind-icon">priority<wbr>Map</a>
</li>
</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-private"><span class="tsd-kind-icon">Private property</span></li>
<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-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-inherited"><span class="tsd-kind-icon">Inherited 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>
</body>
</html>