@mirta/globals 0.2.2 → 0.2.4

package/eslint/index.d.ts

@@ -1,6 +1,9 @@
 declare interface GlobalsMirta {
+  readonly '__DEV__': false
+  readonly '__TEST__': false
   readonly 'log': false
   readonly 'dev': false
+  readonly 'cron': false
   readonly 'timers': false
   readonly 'defineRule': false
   readonly 'defineAlias': false

package/eslint/index.js

@@ -1,6 +1,9 @@
 export default {
+  '__DEV__': 'readonly',
+  '__TEST__': 'readonly',
   'log': 'readonly',
   'dev': 'readonly',
+  'cron': 'readonly',
   'timers': 'readonly',
   'defineRule': 'readonly',
   'defineAlias': 'readonly',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mirta/globals",
   "description": "Complete set of types for wb-rule development in TypeScript",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "license": "Unlicense",
   "keywords": [
     "mirta",

package/types/wb-rules.d.ts

@@ -66,6 +66,10 @@ declare namespace WbRules {
     error(message: string | undefined, ...args: (string | number | boolean)[]): void
   }
 
+  interface CronEntry {
+    spec: string
+  }
+
   interface Timer {
     firing: boolean
 
@@ -99,9 +103,12 @@ declare namespace WbRules {
     asSoonAs?(): boolean
 
     /**
-     * Функция, которая сигнализирует, что правило должно отработать
-     */
-    when?(): number | boolean
+     * Функция или экземпляр {@link CronEntry}, возвращаемый функцией {@link cron}.
+     *
+     * Сигнализирует, когда правило должно отработать.
+     *
+     **/
+    when?: CronEntry | (() => number | boolean)
 
     /**
      * Функция, которая вызывается при срабатывании правила
@@ -460,6 +467,23 @@ declare var dev: WbRules.Dev
 /** Объект доступа к именованным таймера. */
 declare var timers: WbRules.TimerCollection
 
+/**
+ * Используется для ввода спецификации cron-правила.
+ *
+ * Подробное описание формата выражений используемой cron-библиотеки:
+
+ * https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format
+ *
+ * @example
+ * ```ts
+ * defineRule('cron_hourly', {
+ *   when: cron('@hourly'),
+ *   then: () => log('@hourly rule raised')
+ * })
+ * ```
+ **/
+declare function cron(spec: string): WbRules.CronEntry
+
 /**
  * Создаёт правило обработки.
  * @param ruleName Название правила.