Merge branch 'main' into feature/update-docs

Author: Hetarth02

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+Whether you are a pro or a someone who is just starting their Open-Source journey, everyone can contribute to make this package better. To make things consistent, please follow the below mentioned points.
+
+# Guidelines
+
+- Please be sure you have your branch in sync with the `main` branch.
+- Please follow `snake_case` convention wherever possible.
+- Do go through the list of already implemented functions to avoid duplication.
+- The PR you make should have the following points
+  - New function name
+  - Short Description
+  - References (documentation, links, etc.)
+  - Limitations (If it has any edge cases)
+- The function code should also carry appropriate JSDOC comments and a small example displaying both input and output of your function.
+
+# Example PR
+
+```javascript
+// index.js
+/**
+ * Some small description
+ * 
+ * @param array param
+ * @return array
+*/
+function some_new_function(param) {
+    // Your Logic
+    return value;
+}
+```
+
+```javascript
+// README.md
+import { some_new_function } from @hetarth02/js-array-helpers;
+
+console.log(some_new_function(param)); // Output
+```
+
+- some_new_function
+- This function does this thing.
+- param can only be array

README.md

@@ -9,34 +9,71 @@ Array Helper functions for your quick use.
 npm i @hetarth02/js-array-helpers
 ```
 
+# Contributing
+
+- To conttribute please refer [CONTRIBUTING.md](CONTRIBUTING.md).
+
 # How to use
 
 In your `package.json` add the following, `"type": "module"`.
 
-### is_array()
+# Example Usage
+
 ```js
-import { is_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
-```
 
-### object_to_array
-```js
 const objectX = {
     0: "Apple",
     1: "Microsoft",
     2: "Google"
+}; 
+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'
 }
- 
-console.log(object_to_array(objectX)) // ['Apple', 'Microsoft', 'Google']
-```
 
-### search_in_array
-```js
-const mang = ['Microsoft', 'apple', 'netflix', 'Google']
+// Run sanitize_array with array and schema
+console.log(sanitize_array(my_array,my_schema))
 
-const result = search_in_array("app", mang);
+// 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 } 
+//  ]
 
-console.log(result); // ['apple']
 ```