deploy: 7807d10121

kdocs/dev.inmo.krontab/create-simple-scheduler.html

@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-2.0.0    </div>
+2.1.0    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
@@ -59,7 +59,7 @@
   <div class="cover ">
     <h1 class="cover"><span>create</span><wbr></wbr><span>Simple</span><wbr></wbr><span><span>Scheduler</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-simple-scheduler.html"><span class="token function">createSimpleScheduler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">incoming<span class="token operator">: </span><a href="index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/StringParser.kt#L74">source</a>)</span></span></div><p class="paragraph">Parse <a href="create-simple-scheduler.html">incoming</a> string and adapt according to next format: &quot;* * * * *&quot; where order of things:</p><ul><li><p class="paragraph"><strong>seconds</strong></p></li><li><p class="paragraph"><strong>minutes</strong></p></li><li><p class="paragraph"><strong>hours</strong></p></li><li><p class="paragraph"><strong>dayOfMonth</strong></p></li><li><p class="paragraph"><strong>month</strong></p></li><li><p class="paragraph"><strong>year</strong> (optional)</p></li><li><p class="paragraph"><strong>offset</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">o</code> at the end, for example: 60o == +01:00)</p></li><li><p class="paragraph"><strong>dayOfWeek</strong> (optional) (can be placed anywhere after month)</p></li><li><p class="paragraph"><strong>milliseconds</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">ms</code> at the end, for example: 500ms; 100-200ms)</p></li></ul><p class="paragraph">And each one (except of offsets) have next format:</p><p class="paragraph"><code class="lang-kotlin">{number}[,{number},...]</code> or <code class="lang-kotlin">*</code></p><p class="paragraph">and {number} here is one of</p><ul><li><p class="paragraph">{int}-{int}</p></li><li><p class="paragraph">{int}/{int}</p></li><li><p class="paragraph">*/{int}</p></li><li><p class="paragraph">{int}</p></li><li><p class="paragraph">F</p></li><li><p class="paragraph">L</p></li></ul><p class="paragraph">Week days must be marked with <code class="lang-kotlin">w</code> at the end, and starts with 0 which means Sunday. For example, 0w == Sunday. With weeks you can use syntax like with any number like seconds, for example: 0-2w means Sunday-Tuesday</p><p class="paragraph">Additional info about ranges can be found in follow accordance:</p><ul><li><p class="paragraph">Seconds ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//secondsRange/#/PointingToDeclaration/">secondsRange</span></p></li><li><p class="paragraph">Minutes ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//minutesRange/#/PointingToDeclaration/">minutesRange</span></p></li><li><p class="paragraph">Hours ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//hoursRange/#/PointingToDeclaration/">hoursRange</span></p></li><li><p class="paragraph">Days of month ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//dayOfMonthRange/#/PointingToDeclaration/">dayOfMonthRange</span></p></li><li><p class="paragraph">Months ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//monthRange/#/PointingToDeclaration/">monthRange</span></p></li><li><p class="paragraph">Years ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//yearRange/#/PointingToDeclaration/">yearRange</span> (in fact - any <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</p></li><li><p class="paragraph">WeekDay (timezone) ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//dayOfWeekRange/#/PointingToDeclaration/">dayOfWeekRange</span></p></li><li><p class="paragraph">Milliseconds ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//millisecondsRange/#/PointingToDeclaration/">millisecondsRange</span></p></li></ul><p class="paragraph">Examples:</p><ul><li><p class="paragraph">&quot;0/5 * * * *&quot; for every five seconds triggering</p></li><li><p class="paragraph">&quot;0/5,L * * * *&quot; for every five seconds triggering and on 59 second</p></li><li><p class="paragraph">&quot;0/15 30 * * *&quot; for every 15th seconds in a half of each hour</p></li><li><p class="paragraph">&quot;0/15 30 * * * 500ms&quot; for every 15th seconds in a half of each hour when milliseconds equal to 500</p></li><li><p class="paragraph">&quot;1 2 3 F,4,L 5&quot; for triggering in near first second of seconLine truncated
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-simple-scheduler.html"><span class="token function">createSimpleScheduler</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">incoming<span class="token operator">: </span><a href="index.html#-1448720714%2FClasslikes%2F788909594">KrontabTemplate</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-kron-scheduler/index.html">KronScheduler</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/krontab/blob/master//src/commonMain/kotlin/dev/inmo/krontab/StringParser.kt#L75">source</a>)</span></span></div><p class="paragraph">Parse <a href="create-simple-scheduler.html">incoming</a> string and adapt according to next format: &quot;* * * * *&quot; where order of things:</p><ul><li><p class="paragraph"><strong>seconds</strong></p></li><li><p class="paragraph"><strong>minutes</strong></p></li><li><p class="paragraph"><strong>hours</strong></p></li><li><p class="paragraph"><strong>dayOfMonth</strong></p></li><li><p class="paragraph"><strong>month</strong></p></li><li><p class="paragraph"><strong>year</strong> (optional)</p></li><li><p class="paragraph"><strong>offset</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">o</code> at the end, for example: 60o == +01:00)</p></li><li><p class="paragraph"><strong>dayOfWeek</strong> (optional) (can be placed anywhere after month)</p></li><li><p class="paragraph"><strong>milliseconds</strong> (optional) (can be placed anywhere after month) (must be marked with <code class="lang-kotlin">ms</code> at the end, for example: 500ms; 100-200ms)</p></li></ul><p class="paragraph">And each one (except of offsets) have next format:</p><p class="paragraph"><code class="lang-kotlin">{number}[,{number},...]</code> or <code class="lang-kotlin">*</code></p><p class="paragraph">and {number} here is one of</p><ul><li><p class="paragraph">{int}-{int}</p></li><li><p class="paragraph">{int}/{int}</p></li><li><p class="paragraph">*/{int}</p></li><li><p class="paragraph">{int}</p></li><li><p class="paragraph">F</p></li><li><p class="paragraph">L</p></li></ul><p class="paragraph">Week days must be marked with <code class="lang-kotlin">w</code> at the end, and starts with 0 which means Sunday. For example, 0w == Sunday. With weeks you can use syntax like with any number like seconds, for example: 0-2w means Sunday-Tuesday</p><p class="paragraph">Additional info about ranges can be found in follow accordance:</p><ul><li><p class="paragraph">Seconds ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//secondsRange/#/PointingToDeclaration/">secondsRange</span></p></li><li><p class="paragraph">Minutes ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//minutesRange/#/PointingToDeclaration/">minutesRange</span></p></li><li><p class="paragraph">Hours ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//hoursRange/#/PointingToDeclaration/">hoursRange</span></p></li><li><p class="paragraph">Days of month ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//dayOfMonthRange/#/PointingToDeclaration/">dayOfMonthRange</span></p></li><li><p class="paragraph">Months ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//monthRange/#/PointingToDeclaration/">monthRange</span></p></li><li><p class="paragraph">Years ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//yearRange/#/PointingToDeclaration/">yearRange</span> (in fact - any <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</p></li><li><p class="paragraph">WeekDay (timezone) ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//dayOfWeekRange/#/PointingToDeclaration/">dayOfWeekRange</span></p></li><li><p class="paragraph">Milliseconds ranges can be found in <span data-unresolved-link="dev.inmo.krontab.internal//millisecondsRange/#/PointingToDeclaration/">millisecondsRange</span></p></li></ul><p class="paragraph">Examples:</p><ul><li><p class="paragraph">&quot;0/5 * * * *&quot; for every five seconds triggering</p></li><li><p class="paragraph">&quot;0/5,L * * * *&quot; for every five seconds triggering and on 59 second</p></li><li><p class="paragraph">&quot;0/15 30 * * *&quot; for every 15th seconds in a half of each hour</p></li><li><p class="paragraph">&quot;0/15 30 * * * 500ms&quot; for every 15th seconds in a half of each hour when milliseconds equal to 500</p></li><li><p class="paragraph">&quot;1 2 3 F,4,L 5&quot; for triggering in near first second of seconLine truncated
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span