[rules] RuleBuilder: Mark fn for then(fn) as optional (#359)

This fixes wrong JSDoc. Signed-off-by: Florian Hotze <[email protected]>
openhab · Jul 10, 2024 · 9ad5b28 · 9ad5b28
1 parent 8ee0b91
commit 9ad5b28
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/src/rules/condition-builder.js b/src/rules/condition-builder.js
@@ -23,7 +23,7 @@ class ConditionBuilder {
   /**
    * Move to the rule operations
    *
-   * @param {*} fn the optional function to execute
+   * @param {*} [fn] the optional function to execute
    * @returns {operations.OperationBuilder}
    */
   then (fn) {
@@ -60,7 +60,7 @@ class ConditionConf {
 
   /**
      *
-     * @param {*} fn an optional function
+     * @param {*} [fn] an optional function
      * @returns ConditionBuilder
      */
   then (fn) {

diff --git a/src/rules/trigger-builder.js b/src/rules/trigger-builder.js
@@ -140,7 +140,7 @@ class TriggerConf {
   /**
    * Move to the rule operations
    *
-   * @param {*} fn the optional function to execute
+   * @param {*} [fn] the optional function to execute
    * @returns {operations.OperationBuilder}
    */
   then (fn) {

diff --git a/types/rules/condition-builder.d.ts b/types/rules/condition-builder.d.ts
@@ -65,10 +65,10 @@ export class ConditionBuilder {
     /**
      * Move to the rule operations
      *
-     * @param {*} fn the optional function to execute
+     * @param {*} [fn] the optional function to execute
      * @returns {operations.OperationBuilder}
      */
-    then(fn: any): operations.OperationBuilder;
+    then(fn?: any): operations.OperationBuilder;
     /**
       * Condition of an item in determining whether to process rule.
       *

diff --git a/types/rules/condition-builder.d.ts.map b/types/rules/condition-builder.d.ts.map
diff --git a/types/rules/trigger-builder.d.ts b/types/rules/trigger-builder.d.ts
@@ -319,10 +319,10 @@ declare class TriggerConf {
     /**
      * Move to the rule operations
      *
-     * @param {*} fn the optional function to execute
+     * @param {*} [fn] the optional function to execute
      * @returns {operations.OperationBuilder}
      */
-    then(fn: any): operations.OperationBuilder;
+    then(fn?: any): operations.OperationBuilder;
     /**
      * Move to the rule condition
      *

diff --git a/types/rules/trigger-builder.d.ts.map b/types/rules/trigger-builder.d.ts.map