Update return type for getItem to indicate it can return null

openhab · Nov 6, 2024 · 30dce50 · 30dce50
1 parent 90313a3
commit 30dce50
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/src/items/items.js b/src/items/items.js
@@ -638,7 +638,7 @@ function existsItem (name) {
  * @memberof items
  * @param {string} name the name of the Item
  * @param {boolean} [nullIfMissing=false] whether to return null if the Item cannot be found (default is to throw an {@link https://www.openhab.org/javadoc/latest/org/openhab/core/items/itemnotfoundexception ItemNotFoundException})
- * @returns {Item} {@link items.Item} Item or `null` if `nullIfMissing` is true and Item is missing
+ * @returns {Item | null} {@link items.Item} Item or `null` if `nullIfMissing` is true and Item is missing
  */
 function getItem (name, nullIfMissing = false) {
   try {

diff --git a/types/items/items.d.ts b/types/items/items.d.ts
@@ -67,9 +67,9 @@ export function existsItem(name: string): boolean;
  * @memberof items
  * @param {string} name the name of the Item
  * @param {boolean} [nullIfMissing=false] whether to return null if the Item cannot be found (default is to throw an {@link https://www.openhab.org/javadoc/latest/org/openhab/core/items/itemnotfoundexception ItemNotFoundException})
- * @returns {Item} {@link items.Item} Item or `null` if `nullIfMissing` is true and Item is missing
+ * @returns {Item | null} {@link items.Item} Item or `null` if `nullIfMissing` is true and Item is missing
  */
-export function getItem(name: string, nullIfMissing?: boolean): Item;
+export function getItem(name: string, nullIfMissing?: boolean): Item | null;
 /**
  * Gets all openHAB Items.
  *

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