Update type defintions for recent changes

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
openhab · Aug 22, 2022 · 5d67dba · 5d67dba
1 parent a852e00
commit 5d67dba
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 5 deletions.
diff --git a/triggers.js b/triggers.js
@@ -248,7 +248,7 @@ const TimeOfDayTrigger = (time, triggerName) => createTrigger('timer.TimeOfDayTr
  *
  * @memberof triggers
  * @param {string} itemName the name of the DateTime Item
- * @param {boolean} [timeOnly=false] Specifies whether only the time of the Item should be compared or the date and time. 
+ * @param {boolean} [timeOnly=false] Specifies whether only the time of the Item should be compared or the date and time.
  * @param {string} [triggerName] the optional name of the trigger to create
  */
 const DateTimeTrigger = (itemName, timeOnly = false, triggerName) => createTrigger('timer.DateTimeTrigger', triggerName, {

diff --git a/types/rules/rules.d.ts b/types/rules/rules.d.ts
@@ -3,6 +3,7 @@
  *
  * Note:
  * `Group****Trigger`s use the equivalent `Item****Trigger` as trigger for each member.
+ * Time triggers do not provide any event instance, therefore no property is populated.
  */
 export type EventObject = {
     /**
@@ -46,11 +47,11 @@ export type EventObject = {
      */
     status: string;
     /**
-     * for all triggers except {@link triggers.PWMTrigger }, {@link triggers.PIDTrigger }: Type of event that triggered event (change, command, time, triggered, update)
+     * for all triggers except {@link triggers.PWMTrigger }, {@link triggers.PIDTrigger }, time triggers: Type of event that triggered event (change, command, time, triggered, update)
      */
     eventType: string;
     /**
-     * for all triggers except {@link triggers.PWMTrigger }, {@link triggers.PIDTrigger }: Type of trigger that triggered event (for `TimeOfDayTrigger`: `GenericCronTrigger`)
+     * for all triggers except {@link triggers.PWMTrigger }, {@link triggers.PIDTrigger }, time triggers: Type of trigger that triggered event (for `TimeOfDayTrigger`: `GenericCronTrigger`)
      */
     triggerType: string;
     /**

diff --git a/types/rules/rules.d.ts.map b/types/rules/rules.d.ts.map
diff --git a/types/triggers.d.ts b/types/triggers.d.ts
@@ -156,6 +156,18 @@ export function GenericCronTrigger(expression: string, triggerName?: string): Ho
  * @param {string} [triggerName] the optional name of the trigger to create
  */
 export function TimeOfDayTrigger(time: string, triggerName?: string): HostTrigger;
+/**
+ * Creates a trigger that fires at a (optional) date and time specified in an DateTime Item.
+ *
+ * @example
+ * DateTimeTrigger('MyDateTimeItem');
+ *
+ * @memberof triggers
+ * @param {string} itemName the name of the DateTime Item
+ * @param {boolean} [timeOnly=false] Specifies whether only the time of the Item should be compared or the date and time.
+ * @param {string} [triggerName] the optional name of the trigger to create
+ */
+export function DateTimeTrigger(itemName: string, timeOnly?: boolean, triggerName?: string): HostTrigger;
 /**
  * Creates a trigger for the {@link https://openhab.org/addons/automation/pwm/ Pulse Width Modulation (PWM) Automation} add-on.
  *

diff --git a/types/triggers.d.ts.map b/types/triggers.d.ts.map