some-common-functions-js 1.0.2 → 1.0.5

package/CHANGELOG.md

@@ -1,12 +1,12 @@
 # Change log
 
-## Version 1.00 - 2025/11/19 - ITA
+## Version 1.0.0 - 2025/11/19 - ITA
 Genesis.
 
-## Version 1.01 - 2025/11/19 - ITA
+## Version 1.0.1 - 2025/11/19 - ITA
 Improve README.md documentation.
 
-## Version 1.02 - 2025/11/20 - ITA
+## Version 1.0.2 - 2025/11/20 - ITA
 - Improve README.md documentation and move documentation of changes to CHANGELOG.md
 - Move more previously tested and used utility functions to this package. These are:
   - compare(value1, value2, sortDir = 'asc')  
@@ -16,3 +16,11 @@ Improve README.md documentation.
   - getObjArrayWithNoDuplicates(objArray, firstOfDuplicates, ...comparisonFields)
 - Add the "lodash" dependency used by some of these newly added functions.
 
+## Version 1.0.4 - 2025/11/20 - ITA
+- Improved the readability of README.me
+
+## Version 1.05 - 2025/11/21 - ITA
+- Corrected README documentation.
+
+## Version 1.06 - 2025/11/21 - ITA
+- Updated package.json version in lieu of changes. Otherwise the updated package won't be published on npm.

package/README.md

@@ -43,7 +43,6 @@ let car = {
     model: "Ranger",  
     year: "2015",  
 };  
-
 let result = hasOnly(car, "make", "model", "year");  
 // true, because car has *only all of the specified fields and no other fields.  
 
@@ -56,14 +55,12 @@ result = hasOnly(car, "maxSpeed", "gvm", "power");
 result = hasOnly(car, "make", "model");  
 // false, because car has fields other than the specified fields.  
 ```
-
 ### `hasAll(anObject, ...fields)`
 Returns `true` if the object contains **all** the specified fields.  
 The object may contain additional fields.  
 ***Examples***  
 ```
 const { hasAll } = require("some-common-functions-js");  
-
 let car = {  
     make: "Ford",  
     model: "Ranger",  
@@ -71,7 +68,6 @@ let car = {
     power: "1000kW",  
     type: "pickup truck"  
 };  
-
 let result = hasAll(car, "make", "model");  
 // true, because car has all the specified fields.  
 
@@ -110,6 +106,7 @@ Compares two values of the same primitive type, according to the sort direction.
 * Sort directions: 'asc', 'desc'. Default is 'asc'.
 
 ***Examples***  
+```
 const { compare } = require("some-common-functions-js");  
 
 let x = "Fong Kong";  
@@ -117,10 +114,9 @@ let y = "Isaiah Tshabalala";
 let result = compare(x, y);  // -1 because "Fong Kong" is before "Isaiah Tshabalala" in ascending order.  
 result = compare(y, x);  
 console.log(result); // 1 because "Isaiah Tshabalala" is after "Fong Kong" in ascending order.  
-
 result = compare(x, y, 'desc');  
 console.log(result); // 1 because "Fong Kong" is after "Isaiah Tshabalala" in descending order.
-
+```
 ### `binarySearch(anArray, searchVal, startFrom = 0, arraySortDir = 'asc')`
 Binary Searches a sorted primitive type array for a value and returns the index.  
 * ArraySortDir specifies the direction in which the array is sorted (desc or asc).
@@ -132,14 +128,14 @@ Binary Searches a sorted primitive type array for a value and returns the index.
 * Sort directions: 'asc', 'desc'. Default is 'asc'.
 
  ***Example***  
+ ```
  const { binarySearch, compare } = require("some-common-functions-js");  
  let myArray = [100, 101, 102, 103, 104, 105, 106, 107];  
  let index = binarySearch(myArray, 103); // 3  
  let result = compare(103, myArray[index]); // 0, 103 === myArray[index].  
-
  index = binarySearch(myArray, 103, 4); // 4  
  result = compare(103, myArray[4]); // -1 meaning 103 is less than (before) myArray[4]
-
+```
 ### `objCompare(obj1, obj2, ...comparisonFields)`
 Compare 2 objects according to the comparison fields specified in the comparison fields, and return the result.
 * Each each of the comparisonFields must be of the form 'fieldName sortDirection' or 'fieldName'. 
@@ -150,7 +146,6 @@ Compare 2 objects according to the comparison fields specified in the comparison
 ***Example***  
 ```
 const { objCompare } = require('some-common-functions-js');
-
 let anObject = {  
     firstName: "Isaiah",  
     lastName: "Tshabalala",  
@@ -166,7 +161,6 @@ let anObject = {
         }  
     }  
 };  
-
 let anObject2 = {  
     firstName: "Lindiwe",  
     lastName: "Tshabalala",  
@@ -182,7 +176,6 @@ let anObject2 = {
         }  
     }  
 };  
-
 let result = objCompare(anObject, anObject2, "lastName", "firstName");  
 // -1 because "Tshabalala Isaiah" is before "Tshabalala Lindiwe" according to ascending order.  
 
@@ -204,7 +197,6 @@ let anObject3 = {
         }  
     }  
 };  
-
 let objArray = [anObject2, anObject, anObject3];  
 // Using objCompare to sort objects in objArray using multiple fields including nested fields.  
 objArray.sort((obj1, obj2)=> {  
@@ -219,7 +211,6 @@ objArray.sort((obj1, obj2)=> {
                                                     );  
                                                 });  
 console.log(objArray);   
-
 /*  
     [  
         {  
@@ -269,7 +260,6 @@ console.log(objArray);
         }  
     ]  
 */  
-
 let teams = [  
     {  
         score: 85,  
@@ -288,7 +278,8 @@ let teams = [
         numGames: 10  
     }  
 ];  
-// Using objCompare to sort fields where there  
+// Using objCompare to sort fields where there are mixed sort directions.  
+// Sort by score descending, then by numGames ascending.  
 teams.sort((team1, team2) => {  
     return commonFunctions.objCompare(  
                                         team1, team2,  
@@ -297,35 +288,6 @@ teams.sort((team1, team2) => {
                                     );  
 });  
 console.log(teams);  
-/*  
-
-let teams = [  
-    {  
-        score: 85,  
-        numGames: 10  
-    },  
-    {  
-        score: 90,  
-        numGames: 12  
-    },  
-    {  
-        score: 85,  
-        numGames: 8  
-    },  
-    {  
-        score: 90,  
-        numGames: 10  
-    }  
-];  
-// Sort by score descending, then by numGames ascending.  
-objArray.sort((team1, team2) => {  
-    return commonFunctions.objCompare(  
-                                        team1, team2,  
-                                        "score desc",  
-                                        "numGames asc"  
-                                    );  
-});  
-
 /*  
     [  
         { score: 90, numGames: 10 },  
@@ -354,14 +316,11 @@ let teamsArray = [
     { score: 85, numGames: 8 },  
     { score: 85, numGames: 10 }  
 ]; // Sorted by "score desc", "numGames asc".  
-
-
 let searchObj = { score: 85, numGames: 8 };  
 let anIndex = (commonFunctions.binarySearchObj(teamsArray, searchObj, "score desc", "numGames asc"));  
 
 let result = commonFunctions.objCompare(searchObj, teamsArray[anIndex], "score desc", "numGames asc"); // 0 -- an object with value { score: 85, numGames: 8} exists at teamsArray[anIndex];  
 ```
-
 ## 4. `getObjArrayWithNoDuplicates(objArray, firstOfDuplicates, ...comparisonFields)`
 Create an array of objects with duplicates eliminated. Taking only the first or last object from each duplicate set. The input array must be sorted according to the values comparisonFields.  
  * If firstOfDuplicates === true, then the first element in each set of duplicates is taken.  
@@ -399,9 +358,7 @@ console.log(noDuplicatesArray); // Should contain only unique objects according
     ]  
 */  
 ```
-
 ---
-
 ## License
 MIT
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "some-common-functions-js",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "Common functions used with Javascript objects, and field validation functions.",
   "keywords": [
     "validation",