@trackunit/ui-icons 0.0.124 → 0.0.125

package/index.cjs.js

@@ -329,6 +329,15 @@ const validateIconName = (name) => {
     const found = Object.keys(iconNames).find(i => i === name) ? true : false;
     return found;
 };
+/**
+ * Checks if the icon name is valid.
+ *
+ * @param name - The icon name to validate.
+ * @returns {boolean} - Returns true if the icon name is valid, otherwise it returns false.
+ */
+const isIconName = (name) => {
+    return typeof name === "string" && Object.prototype.hasOwnProperty.call(iconNames, name);
+};
 /**
  * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
  *
@@ -362,3 +371,4 @@ const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) =>
 
 exports.ensureIconWithFallback = ensureIconWithFallback;
 exports.iconNames = iconNames;
+exports.isIconName = isIconName;

package/index.esm.js

@@ -327,6 +327,15 @@ const validateIconName = (name) => {
     const found = Object.keys(iconNames).find(i => i === name) ? true : false;
     return found;
 };
+/**
+ * Checks if the icon name is valid.
+ *
+ * @param name - The icon name to validate.
+ * @returns {boolean} - Returns true if the icon name is valid, otherwise it returns false.
+ */
+const isIconName = (name) => {
+    return typeof name === "string" && Object.prototype.hasOwnProperty.call(iconNames, name);
+};
 /**
  * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
  *
@@ -358,4 +367,4 @@ const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) =>
     }
 };
 
-export { ensureIconWithFallback, iconNames };
+export { ensureIconWithFallback, iconNames, isIconName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/ui-icons",
-  "version": "0.0.124",
+  "version": "0.0.125",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/ensureIconWithFallback.d.ts

@@ -1,4 +1,11 @@
 import { IconName } from "./icons.generated";
+/**
+ * Checks if the icon name is valid.
+ *
+ * @param name - The icon name to validate.
+ * @returns {boolean} - Returns true if the icon name is valid, otherwise it returns false.
+ */
+export declare const isIconName: (name: unknown) => name is IconName;
 /**
  * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
  *
@@ -6,4 +13,4 @@ import { IconName } from "./icons.generated";
  * @param fallbackIconName - The fallback icon name to use if the icon name is invalid.
  * @returns {IconName} - Returns the icon name if it is valid, otherwise it returns the fallback icon name.
  */
-export declare const ensureIconWithFallback: (name: string | undefined, fallbackIconName?: IconName) => IconName;
+export declare const ensureIconWithFallback: (name: IconName | string | undefined, fallbackIconName?: IconName) => IconName;