[items] Item: Add category field & Add missing null return value in JSDoc (#513)

Closes #508.

Signed-off-by: Florian Hotze <dev@florianhotze.com>

Author: florian-h05

src/items/items.js

@@ -162,16 +162,24 @@ class Item {
   }
 
   /**
-   * Label attached to Item
-   * @type {string}
+   * Label attached to Item, or `null` if not set
+   * @type {string|null}
    */
   get label () {
     return this.rawItem.getLabel();
   }
 
   /**
-   * String representation of the Item state.
-   * @type {string}
+   * Category of the Item, or `null` if not set
+   * @return {string|null}
+   */
+  get category () {
+    return this.rawItem.getCategory();
+  }
+
+  /**
+   * String representation of the Item state, or `null` if not available
+   * @type {string|null}
    */
   get state () {
     return _stateOrNull(this.rawState);
@@ -207,7 +215,7 @@ class Item {
 
   /**
    * Raw state of Item, as a Java {@link https://www.openhab.org/javadoc/latest/org/openhab/core/types/state State object}
-   * @type {HostState}
+   * @type {HostState|null}
    */
   get rawState () {
     return this.rawItem.getState();

types/items/itemchannellink.d.ts

@@ -6,11 +6,12 @@ export type Item = {
     readonly groupType: string;
     readonly name: string;
     readonly label: string;
+    readonly category: string;
     readonly state: string;
     readonly numericState: number;
     readonly quantityState: import("../quantity").Quantity;
     readonly boolState: boolean;
-    readonly rawState: HostState;
+    readonly rawState: any;
     readonly previousState: string;
     readonly previousNumericState: number;
     readonly previousQuantityState: import("../quantity").Quantity;

types/items/itemchannellink.d.ts.map

@@ -186,13 +186,18 @@ export class Item {
      */
     get name(): string;
     /**
-     * Label attached to Item
-     * @type {string}
+     * Label attached to Item, or `null` if not set
+     * @type {string|null}
      */
     get label(): string;
     /**
-     * String representation of the Item state.
-     * @type {string}
+     * Category of the Item, or `null` if not set
+     * @return {string|null}
+     */
+    get category(): string;
+    /**
+     * String representation of the Item state, or `null` if not available
+     * @type {string|null}
      */
     get state(): string;
     /**
@@ -212,9 +217,9 @@ export class Item {
     get boolState(): boolean;
     /**
      * Raw state of Item, as a Java {@link https://www.openhab.org/javadoc/latest/org/openhab/core/types/state State object}
-     * @type {HostState}
+     * @type {HostState|null}
      */
-    get rawState(): HostState;
+    get rawState(): any;
     /**
      * String representation of the previous state of the Item or `null` if no previous state is available.
      * @type {string|null}

types/items/items.d.ts

@@ -6,11 +6,12 @@ export type Item = {
     readonly groupType: string;
     readonly name: string;
     readonly label: string;
+    readonly category: string;
     readonly state: string;
     readonly numericState: number;
     readonly quantityState: import("../quantity").Quantity;
     readonly boolState: boolean;
-    readonly rawState: HostState;
+    readonly rawState: any;
     readonly previousState: string;
     readonly previousNumericState: number;
     readonly previousQuantityState: import("../quantity").Quantity;

types/items/items.d.ts.map

@@ -6,11 +6,12 @@ export type Item = {
     readonly groupType: string;
     readonly name: string;
     readonly label: string;
+    readonly category: string;
     readonly state: string;
     readonly numericState: number;
     readonly quantityState: Quantity;
     readonly boolState: boolean;
-    readonly rawState: HostState;
+    readonly rawState: any;
     readonly previousState: string;
     readonly previousNumericState: number;
     readonly previousQuantityState: Quantity;

types/items/metadata.d.ts

@@ -6,11 +6,12 @@ export type Item = {
     readonly groupType: string;
     readonly name: string;
     readonly label: string;
+    readonly category: string;
     readonly state: string;
     readonly numericState: number;
     readonly quantityState: import("../quantity").Quantity;
     readonly boolState: boolean;
-    readonly rawState: HostState;
+    readonly rawState: any;
     readonly previousState: string;
     readonly previousNumericState: number;
     readonly previousQuantityState: import("../quantity").Quantity;