@bbashcode/lotide-flex/without.js

A clone of the lodash JavaScript library to practice creating various types of functions using JS.

/**
 * eqArrays method is used to compare two arrays for a perfect match
 * @param  {array} array1 The first param
 * @param  {array} array2 The second param
 * @return {boolean} returns true or false depending on whether both arrays are equal or not
 */
 const eqArrays = (array1, array2) =>
 array1.length === array2.length &&
 array1.every((element, index) => element === array2[index]);


 /**
 * assertArraysEqual method is used for asserting that two arrays are equal
 * @param  {array} actual The first param
 * @param  {array} expected The second param
 * @return {void/undefined} This method does not return anything, rather the side effect is to console log test pass or fail based on comparison
 */
const assertArraysEqual = function(actual, expected) {
  if (eqArrays(actual, expected)) {
    console.log(`✅✅✅ Assertion Passed: ${actual} === ${expected}`);
  } else {
    console.log(`🛑🛑🛑 Assertion Failed: ${actual} !== ${expected}`);
  }
};

 /**
 * without method is used for removing specified unwanted items
 * @param  {array} source The first param, original array
 * @param  {array} itemsToRemove The second param, array containing elements to be removed from the original array
 * @return {array} returns the original array after removing the unwanted elements
 */
const without = function removeSpecifiedItems(source, itemsToRemove) {
  itemsToRemove.forEach((element)=>{
    if(source.includes(element)){
      let indexOfRemoveItem = source.indexOf(element);
      source.splice(indexOfRemoveItem, 1);
    }
  });

  return source;
};

//TEST CODE
console.log(without([1, 2, 3], [1])); // => [2, 3]
console.log(without(["1", "2", "3"], [1, 2, "3"])); // => ["1", "2"])

const words = ["hello", "world", "lighthouse"];
without(words, ["lighthouse"]); // no need to capture return value for this test case
// Make sure the original array was not altered by the without function
assertArraysEqual(words, ["hello", "world", "lighthouse"]);