[items] Item: Add number to JSDoc for postUpdate/sendCommand

Signed-off-by: Florian Hotze <[email protected]>
openhab · Jan 18, 2024 · 903599f · 903599f
1 parent c8c644a
commit 903599f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/items/items.js b/items/items.js
@@ -250,7 +250,7 @@ class Item {
   /**
    * Sends a command to the Item.
    *
-   * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
    * @see sendCommandIfDifferent
    * @see postUpdate
    */
@@ -261,7 +261,7 @@ class Item {
   /**
    * Sends a command to the Item, but only if the current state is not what is being sent.
    *
-   * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
    * @returns {boolean} true if the command was sent, false otherwise
    * @see sendCommand
    */
@@ -325,7 +325,7 @@ class Item {
   /**
    * Posts an update to the Item.
    *
-   * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
    * @see postToggleUpdate
    * @see sendCommand
    */

diff --git a/types/actions.d.ts.map b/types/actions.d.ts.map
diff --git a/types/items/items.d.ts b/types/items/items.d.ts
@@ -230,19 +230,19 @@ export class Item {
     /**
      * Sends a command to the Item.
      *
-     * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
      * @see sendCommandIfDifferent
      * @see postUpdate
      */
-    sendCommand(value: string | time.ZonedDateTime | Quantity | HostState): void;
+    sendCommand(value: string | number | time.ZonedDateTime | Quantity | HostState): void;
     /**
      * Sends a command to the Item, but only if the current state is not what is being sent.
      *
-     * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
      * @returns {boolean} true if the command was sent, false otherwise
      * @see sendCommand
      */
-    sendCommandIfDifferent(value: string | time.ZonedDateTime | Quantity | HostState): boolean;
+    sendCommandIfDifferent(value: string | number | time.ZonedDateTime | Quantity | HostState): boolean;
     /**
      * Calculates the toggled state of this Item. For Items like Color and
      * Dimmer, getStateAs(OnOffType) is used and the toggle calculated off
@@ -266,11 +266,11 @@ export class Item {
     /**
      * Posts an update to the Item.
      *
-     * @param {string|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
      * @see postToggleUpdate
      * @see sendCommand
      */
-    postUpdate(value: string | time.ZonedDateTime | Quantity | HostState): void;
+    postUpdate(value: string | number | time.ZonedDateTime | Quantity | HostState): void;
     /**
      * Gets the names of the groups this Item is member of.
      * @returns {string[]}

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