@twin.org/core 0.0.1-next.34 → 0.0.1-next.36

package/dist/cjs/index.cjs

@@ -2767,6 +2767,36 @@ class ObjectHelper {
         const jsonExtended = JsonHelper.stringifyEx(obj);
         return JsonHelper.parseEx(jsonExtended);
     }
+    /**
+     * Remove empty properties from an object.
+     * @param obj The object to remove the empty properties from.
+     * @param options The options for the removal.
+     * @param options.removeUndefined Remove undefined properties, defaults to true.
+     * @param options.removeNull Remove null properties, defaults to false.
+     * @returns The object with empty properties removed.
+     */
+    static removeEmptyProperties(obj, options) {
+        if (Is.object(obj)) {
+            const removeUndefined = options?.removeUndefined ?? true;
+            const removeNull = options?.removeNull ?? false;
+            const newObj = {};
+            const keys = Object.keys(obj);
+            for (const key of keys) {
+                if (!((removeUndefined && Is.undefined(obj[key])) || (removeNull && Is.null(obj[key])))) {
+                    newObj[key] = ObjectHelper.removeEmptyProperties(obj[key], options);
+                }
+            }
+            return newObj;
+        }
+        else if (Is.array(obj)) {
+            const arr = [];
+            for (const element of obj) {
+                arr.push(ObjectHelper.removeEmptyProperties(element, options));
+            }
+            return arr;
+        }
+        return obj;
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/esm/index.mjs

@@ -2765,6 +2765,36 @@ class ObjectHelper {
         const jsonExtended = JsonHelper.stringifyEx(obj);
         return JsonHelper.parseEx(jsonExtended);
     }
+    /**
+     * Remove empty properties from an object.
+     * @param obj The object to remove the empty properties from.
+     * @param options The options for the removal.
+     * @param options.removeUndefined Remove undefined properties, defaults to true.
+     * @param options.removeNull Remove null properties, defaults to false.
+     * @returns The object with empty properties removed.
+     */
+    static removeEmptyProperties(obj, options) {
+        if (Is.object(obj)) {
+            const removeUndefined = options?.removeUndefined ?? true;
+            const removeNull = options?.removeNull ?? false;
+            const newObj = {};
+            const keys = Object.keys(obj);
+            for (const key of keys) {
+                if (!((removeUndefined && Is.undefined(obj[key])) || (removeNull && Is.null(obj[key])))) {
+                    newObj[key] = ObjectHelper.removeEmptyProperties(obj[key], options);
+                }
+            }
+            return newObj;
+        }
+        else if (Is.array(obj)) {
+            const arr = [];
+            for (const element of obj) {
+                arr.push(ObjectHelper.removeEmptyProperties(element, options));
+            }
+            return arr;
+        }
+        return obj;
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/types/helpers/objectHelper.d.ts

@@ -92,4 +92,16 @@ export declare class ObjectHelper {
      * @returns The object with regular properties.
      */
     static fromExtended(obj: any): any;
+    /**
+     * Remove empty properties from an object.
+     * @param obj The object to remove the empty properties from.
+     * @param options The options for the removal.
+     * @param options.removeUndefined Remove undefined properties, defaults to true.
+     * @param options.removeNull Remove null properties, defaults to false.
+     * @returns The object with empty properties removed.
+     */
+    static removeEmptyProperties<T = unknown>(obj: T, options?: {
+        removeUndefined?: boolean;
+        removeNull?: boolean;
+    }): T;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/core - Changelog
 
-## 0.0.1-next.34
+## 0.0.1-next.36
 
 - Initial Release

package/docs/reference/classes/ObjectHelper.md

@@ -411,3 +411,45 @@ The object to convert.
 `any`
 
 The object with regular properties.
+
+***
+
+### removeEmptyProperties()
+
+> `static` **removeEmptyProperties**\<`T`\>(`obj`, `options`?): `T`
+
+Remove empty properties from an object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+##### obj
+
+`T`
+
+The object to remove the empty properties from.
+
+##### options?
+
+The options for the removal.
+
+###### removeUndefined
+
+`boolean`
+
+Remove undefined properties, defaults to true.
+
+###### removeNull
+
+`boolean`
+
+Remove null properties, defaults to false.
+
+#### Returns
+
+`T`
+
+The object with empty properties removed.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.34",
+	"version": "0.0.1-next.36",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",