[items] Add Instant as valid parameter type for sendCommand & postUpdate

Signed-off-by: Florian Hotze <[email protected]>

Author: florian-h05

src/items/items.js

@@ -38,7 +38,11 @@ const itemBuilderFactory = osgi.getService('org.openhab.core.items.ItemBuilderFa
  * @private
  */
 /**
- * @typedef {import('@js-joda/core').ZonedDateTime} time.ZonedDateTime
+ * @typedef {import('@js-joda/core').ZonedDateTime} ZonedDateTime
+ * @private
+ */
+/**
+ * @typedef {import('@js-joda/core').Instant} Instant
  * @private
  */
 /**
@@ -231,7 +235,7 @@ class Item {
   /**
    * Sends a command to the Item.
    *
-   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|ZonedDateTime|Instant|Quantity|HostState} value the value of the command to send, such as 'ON'
    * @see sendCommandIfDifferent
    * @see postUpdate
    */
@@ -242,7 +246,7 @@ class Item {
   /**
    * Sends a command to the Item, but only if the current state is not what is being sent.
    *
-   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|ZonedDateTime|Instant|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
    */
@@ -388,7 +392,7 @@ class Item {
   /**
    * Posts an update to the Item.
    *
-   * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+   * @param {string|number|ZonedDateTime|Instant|Quantity|HostState} value the value of the command to send, such as 'ON'
    * @see postToggleUpdate
    * @see sendCommand
    */

types/items/items.d.ts

@@ -240,19 +240,19 @@ export class Item {
     /**
      * Sends a command to the Item.
      *
-     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|time.Instant|Quantity|HostState} value the value of the command to send, such as 'ON'
      * @see sendCommandIfDifferent
      * @see postUpdate
      */
-    sendCommand(value: string | number | time.ZonedDateTime | Quantity | HostState): void;
+    sendCommand(value: string | number | time.ZonedDateTime | time.Instant | Quantity | HostState): void;
     /**
      * Sends a command to the Item, but only if the current state is not what is being sent.
      *
-     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|time.Instant|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 | number | time.ZonedDateTime | Quantity | HostState): boolean;
+    sendCommandIfDifferent(value: string | number | time.ZonedDateTime | time.Instant | Quantity | HostState): boolean;
     /**
      * Increase the value of this Item to the given value by sending a command, but only if the current state is less than that value.
      *
@@ -290,11 +290,11 @@ export class Item {
     /**
      * Posts an update to the Item.
      *
-     * @param {string|number|time.ZonedDateTime|Quantity|HostState} value the value of the command to send, such as 'ON'
+     * @param {string|number|time.ZonedDateTime|time.Instant|Quantity|HostState} value the value of the command to send, such as 'ON'
      * @see postToggleUpdate
      * @see sendCommand
      */
-    postUpdate(value: string | number | time.ZonedDateTime | Quantity | HostState): void;
+    postUpdate(value: string | number | time.ZonedDateTime | time.Instant | Quantity | HostState): void;
     /**
      * Gets the names of the groups this Item is member of.
      * @returns {string[]}
@@ -333,6 +333,7 @@ import ItemPersistence = require("./item-persistence");
 import ItemSemantics = require("./item-semantics");
 declare namespace time {
     type ZonedDateTime = import('@js-joda/core').ZonedDateTime;
+    type Instant = import('@js-joda/core').Instant;
 }
 export { metadata, TimeSeries };
 //# sourceMappingURL=items.d.ts.map

types/items/metadata/metadata.d.ts

@@ -5,7 +5,17 @@ export type Item = {
     readonly type: string;
     readonly name: string;
     readonly label: string;
-    readonly state: string;
+    readonly state: string; /**
+     * Updates or adds metadata of a single namespace to an Item.
+     *
+     * @see items.Item.replaceMetadata
+     * @memberof items.metadata
+     * @param {Item|string} itemOrName {@link Item} or the name of the Item * @param {string} namespace name of the metadata
+     * @param {string} namespace name of the metadata
+     * @param {string} value value for this metadata
+     * @param {object} [configuration] optional metadata configuration
+     * @returns {ItemMetadata|null} old metadata or `null` if the Item has no metadata with the given name
+     */
     readonly numericState: number;
     readonly quantityState: import("../../quantity").Quantity;
     readonly rawState: HostState;

types/quantity.d.ts

@@ -1,10 +1,6 @@
 export type Item = {
     rawItem: HostItem;
     persistence: import("./items/item-persistence");
-    /**
-     * QuantityError is thrown when {@link Quantity} creation or operation fails.
-     * It is used to wrap the underlying Java Exceptions and add some additional information and a JS stacktrace to it.
-     */
     semantics: import("./items/item-semantics");
     readonly type: string;
     readonly name: string;

types/rules/operation-builder.d.ts

@@ -9,7 +9,14 @@ export type Item = {
     readonly numericState: number;
     readonly quantityState: import("../quantity").Quantity;
     readonly rawState: HostState;
-    readonly members: any[];
+    readonly members: any[]; /**
+       * Build this rule
+       *
+       * @param {string} [name] of the rule
+       * @param {string} [description] of the rule
+       * @param {Array<String>} [tags] of the rule
+       * @param {string} [id] of the rule
+       */
     readonly descendents: any[];
     readonly isUninitialized: boolean;
     getMetadata(namespace?: string): {