feat(removeElementFromArray) : Add removeElementFromArray function (#171)

Closes #5

Author: Vinnu1

.editorconfig

@@ -0,0 +1,3 @@
+root = true
+[*.js]
+end_of_line = lf

src/index.js

@@ -61,6 +61,7 @@ import reverse from './reverse'
 import removeAccents from './remove-accents'
 import getQueryStringValue from './get-query-string-value'
 import isLeapYear from './leap-year'
+import removeElementFromArray from './removeElementFromArray'
 
 export {
   reverseArrayInPlace,
@@ -126,4 +127,5 @@ export {
   getQueryStringValue,
   lessThan,
   isLeapYear,
+  removeElementFromArray,
 }

src/removeElementFromArray.js

@@ -0,0 +1,17 @@
+export default removeElementFromArray
+
+/**
+ * This method will remove element and return rest of the array
+ *
+ * @param {Array} arr - the array
+ * @param {Number} re - element to be removed
+ * @return {Array} - new array
+ */
+
+function removeElementFromArray(arr, re) {
+  const index = arr.indexOf(re)
+  if (index > -1) {
+    arr.splice(index, 1)
+  }
+  return arr
+}

test/removeElementFromArray.test.js

@@ -0,0 +1,18 @@
+import test from 'ava'
+import {removeElementFromArray} from '../src'
+
+test('Remove an element from array', t => {
+  const arr = [0, 1, 2, 3]
+  const number = 3
+  const expected = [0, 1, 2]
+  const actual = removeElementFromArray(arr, number)
+  t.deepEqual(actual, expected)
+})
+
+test('Element not found', t => {
+  const arr = [0, 1, 2, 3]
+  const number = 4
+  const expected = [0, 1, 2, 3]
+  const actual = removeElementFromArray(arr, number)
+  t.deepEqual(actual, expected)
+})