feat: Add function to see if string is palindrome (#96)

This function removes all non-alphanumeric characters and spaces and then checks to see if the

string is a palindrome

Author: jdrichardstech

src/checkPalindrome.js

@@ -0,0 +1,19 @@
+export default checkPalindrome
+
+/**
+*Original Source: https://stackoverflow.com/questions/41739845/freecodecamp-checking-for-palindromes
+*This method will check to see if
+*after removing all non alphanumeric characters,
+*the string is a palindrome
+* @param {String} str - string to check for Palindrome
+* @return {Boolean} - should return true or false
+*/
+
+function checkPalindrome(str) {
+  const newstr = str.replace(/[\W_]/g, '').toLowerCase()
+
+  if (newstr === newstr.split('').reverse().join('')) {
+    return true
+  }
+  return false
+}

src/index.js

@@ -31,6 +31,7 @@ import shallowEqual from './shallow-equal'
 import swapCase from './swap-case'
 import endsWith from './endsWith'
 import round from './round'
+import checkPalindrome from './checkPalindrome'
 
 export {
   initArray,
@@ -66,4 +67,5 @@ export {
   swapCase,
   endsWith,
   round,
+  checkPalindrome,
 }

test/checkPalindrome.test.js

@@ -0,0 +1,16 @@
+import test from 'ava'
+import {checkPalindrome} from '../src'
+
+test('string is not a palindrome', t => {
+  const object = 'hello world'
+  const expected = false
+  const actual = checkPalindrome(object)
+  t.deepEqual(actual, expected)
+})
+
+test(' string is a palindrome', t => {
+  const object = 'l/o1&&9_J$$J 9!1ol'
+  const expected = true
+  const actual = checkPalindrome(object)
+  t.deepEqual(actual, expected)
+})