docs/agenda/4.x/interfaces/ijobdefinition.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IJobDefinition | @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>
<li>
<a href="ijobdefinition.html">IJobDefinition</a>
</li>
</ul>
<h1>Interface IJobDefinition<DATA></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>DATA = <span class="tsd-signature-type">unknown</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IJobDefinition</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="ijobdefinition.html#concurrency" class="tsd-kind-icon">concurrency</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ijobdefinition.html#fn" class="tsd-kind-icon">fn</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ijobdefinition.html#locklifetime" class="tsd-kind-icon">lock<wbr>Lifetime</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ijobdefinition.html#locklimit" class="tsd-kind-icon">lock<wbr>Limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ijobdefinition.html#priority" class="tsd-kind-icon">priority</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="concurrency" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> concurrency</h3>
<div class="tsd-signature tsd-kind-icon">concurrency<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobDefinition.ts#L11">src/types/JobDefinition.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>how many jobs of this kind can run in parallel/simultanously per Agenda instance</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fn" class="tsd-anchor"></a>
<h3>fn</h3>
<div class="tsd-signature tsd-kind-icon">fn<span class="tsd-signature-symbol">:</span> <a href="../globals.html#definitionprocessor" class="tsd-signature-type">DefinitionProcessor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DATA</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-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</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/types/JobDefinition.ts#L13">src/types/JobDefinition.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="locklifetime" class="tsd-anchor"></a>
<h3>lock<wbr>Lifetime</h3>
<div class="tsd-signature tsd-kind-icon">lock<wbr>Lifetime<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobDefinition.ts#L7">src/types/JobDefinition.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>lock lifetime in milliseconds</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="locklimit" class="tsd-anchor"></a>
<h3>lock<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">lock<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobDefinition.ts#L5">src/types/JobDefinition.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>max number of locked jobs of this kind</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="priority" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> priority</h3>
<div class="tsd-signature tsd-kind-icon">priority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hokify/agenda/blob/bd6157a/src/types/JobDefinition.ts#L9">src/types/JobDefinition.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Higher priority jobs will run first.</p>
</div>
</div>
</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">
<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="iagendaconfig.html" class="tsd-kind-icon">IAgenda<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="iagendajobstatus.html" class="tsd-kind-icon">IAgenda<wbr>Job<wbr>Status</a>
</li>
<li class=" tsd-kind-interface">
<a href="iagendastatus.html" class="tsd-kind-icon">IAgenda<wbr>Status</a>
</li>
<li class=" tsd-kind-interface">
<a href="idatabaseoptions.html" class="tsd-kind-icon">IDatabase<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="idbconfig.html" class="tsd-kind-icon">IDb<wbr>Config</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="ijobdefinition.html" class="tsd-kind-icon">IJob<wbr>Definition</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ijobdefinition.html#concurrency" class="tsd-kind-icon">concurrency</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ijobdefinition.html#fn" class="tsd-kind-icon">fn</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ijobdefinition.html#locklifetime" class="tsd-kind-icon">lock<wbr>Lifetime</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ijobdefinition.html#locklimit" class="tsd-kind-icon">lock<wbr>Limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ijobdefinition.html#priority" class="tsd-kind-icon">priority</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="ijobparameters.html" class="tsd-kind-icon">IJob<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface">
<a href="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>