Merge branch 'main' into main

Author: Hetarth02

README.md

@@ -20,7 +20,7 @@ In your `package.json` add the following, `"type": "module"`.
 # Example Usage
 
 ```js
-import { is_array, object_to_array, search_in_array } from "@hetarth02/js-array-helpers";
+import { is_array, object_to_array, search_in_array,sanitize_array } from "@hetarth02/js-array-helpers";
 
 let arr = [1, 2];
 console.log(is_array(arr)); // true
@@ -35,4 +35,45 @@ console.log(object_to_array(objectX)); // ['Apple', 'Microsoft', 'Google']
 const mang = ['Microsoft', 'apple', 'netflix', 'Google'];
 const result = search_in_array("app", mang);
 console.log(result); // ['apple']
+
+
+
+
+
+
+// Santized array Example
+
+// Corrupted Data array with diff data types
+const my_array = [
+    {name:'sam',    age:null,       isEmployed:'false'},    
+    {name:'a',      age:456,        isEmployed:false},    
+    {name:'c',      age:undefined,  isEmployed:00}    ,
+    {name:null,     age:123,        isEmployed:true}    ,
+    {name:'asd',    age:123,        isEmployed:false}   , 
+    {name:00,       age:123,        isEmployed:null}    ,
+    {name:'sam',    age:'123',      isEmployed:undefined}    
+]
+
+
+
+// Given schema for correct data types
+const my_schema = {
+    "name":'string',
+    "age":'number',
+    "isEmployed":'boolean'
+}
+
+// Run sanitize_array with array and schema
+console.log(sanitize_array(my_array,my_schema))
+
+// Sanitized Output 
+// [    { name: 'sam', age: 0, isEmployed: false },
+//      { name: 'a', age: 456, isEmployed: false },
+//      { name: 'c', age: 0, isEmployed: true },
+//      { name: 'null', age: 123, isEmployed: true },
+//      { name: 'asd', age: 123, isEmployed: false },
+//      { name: '0', age: 123, isEmployed: false },
+//      { name: 'sam', age: 123, isEmployed: false } 
+//  ]
+
 ```

index.js

@@ -223,6 +223,60 @@ function difference(arr1, arr2) {
   return arr1.filter((item) => !arr2.includes(item));
 }
 
+/**
+ * To sanitize the array of objects with respect to the given schema
+ *
+ * See exmaple in Readme for better understanding....
+ * 
+ * @param array arr
+ * @param object schema { "keyName":"dataType" }
+ * @return array
+ * 
+ */
+
+function sanitize_array(arr,schema){
+    let all_data_types = [];
+    let all_keys = [];
+
+    const schema_array = Object.entries(schema);
+    schema_array.forEach((type) => all_data_types.push(type[1]));
+    
+    schema_array.forEach((key) => all_keys.push(key[0]));
+    
+    arr.forEach((element)=>{
+        all_keys.forEach((key,key_index)=>{
+             if(`${typeof(element[all_keys[key_index]])}`!==`${all_data_types[key_index]}`){
+                if(all_data_types[key_index]=='number'){
+                    if(!isNaN(parseInt(element[all_keys[key_index]]))){
+                        element[all_keys[key_index]] = parseInt(element[all_keys[key_index]]);
+                    }else{
+                        element[all_keys[key_index]] = 0;
+                    }
+                }else if(all_data_types[key_index]=='string'){
+                    element[all_keys[key_index]] = `${element[all_keys[key_index]]}`;
+                }else if(all_data_types[key_index]=='boolean'){
+                    if( element[all_keys[key_index]]=='true'){
+                        element[all_keys[key_index]] = true;
+                    }else if(element[all_keys[key_index]]=='false'){
+                        element[all_keys[key_index]] = false;
+                    }else if(element[all_keys[key_index]]==null){
+                        element[all_keys[key_index]] = false;
+                    }else{
+                        element[all_keys[key_index]] = true;
+                    }
+                }else{
+                    element[all_keys[key_index]] = null;
+                }
+                 
+             }
+        })
+
+       
+    })
+    
+    return arr
+}
+
 export {
   is_array,
   is_num_array,
@@ -242,4 +296,5 @@ export {
   flatten,
   intersection,
   difference,
+  sanitize_array,
 };