@twin.org/core 0.0.1-next.7 → 0.0.1-next.8

package/dist/cjs/index.cjs

@@ -2819,6 +2819,26 @@ class ObjectHelper {
             delete obj[property];
         }
     }
+    /**
+     * Extract a property from the object, providing alternative names.
+     * @param obj The object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param removeProperties Remove the properties from the object, defaults to true.
+     * @returns The property if available.
+     */
+    static extractProperty(obj, propertyNames, removeProperties = true) {
+        let retVal;
+        if (Is.object(obj)) {
+            const names = Is.string(propertyNames) ? [propertyNames] : propertyNames;
+            for (const prop of names) {
+                retVal ??= ObjectHelper.propertyGet(obj, prop);
+                if (removeProperties) {
+                    ObjectHelper.propertyDelete(obj, prop);
+                }
+            }
+        }
+        return retVal;
+    }
     /**
      * Pick a subset of properties from an object.
      * @param obj The object to pick the properties from.

package/dist/esm/index.mjs

@@ -2817,6 +2817,26 @@ class ObjectHelper {
             delete obj[property];
         }
     }
+    /**
+     * Extract a property from the object, providing alternative names.
+     * @param obj The object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param removeProperties Remove the properties from the object, defaults to true.
+     * @returns The property if available.
+     */
+    static extractProperty(obj, propertyNames, removeProperties = true) {
+        let retVal;
+        if (Is.object(obj)) {
+            const names = Is.string(propertyNames) ? [propertyNames] : propertyNames;
+            for (const prop of names) {
+                retVal ??= ObjectHelper.propertyGet(obj, prop);
+                if (removeProperties) {
+                    ObjectHelper.propertyDelete(obj, prop);
+                }
+            }
+        }
+        return retVal;
+    }
     /**
      * Pick a subset of properties from an object.
      * @param obj The object to pick the properties from.

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

@@ -57,6 +57,14 @@ export declare class ObjectHelper {
      * @param property The property to set
      */
     static propertyDelete(obj: unknown, property: string): void;
+    /**
+     * Extract a property from the object, providing alternative names.
+     * @param obj The object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param removeProperties Remove the properties from the object, defaults to true.
+     * @returns The property if available.
+     */
+    static extractProperty<T>(obj: unknown, propertyNames: string | string[], removeProperties?: boolean): T | undefined;
     /**
      * Pick a subset of properties from an object.
      * @param obj The object to pick the properties from.

package/docs/changelog.md

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

package/docs/reference/classes/ObjectHelper.md

@@ -232,6 +232,38 @@ The property to set
 
 ***
 
+### extractProperty()
+
+> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `undefined` \| `T`
+
+Extract a property from the object, providing alternative names.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj**: `unknown`
+
+The object to extract from.
+
+• **propertyNames**: `string` \| `string`[]
+
+The possible names for the property.
+
+• **removeProperties**: `boolean` = `true`
+
+Remove the properties from the object, defaults to true.
+
+#### Returns
+
+`undefined` \| `T`
+
+The property if available.
+
+***
+
 ### pick()
 
 > `static` **pick**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>

package/package.json

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