feat: add deepArrayIncludes

src/functions/deep-includes.spec.ts

@@ -0,0 +1,15 @@
+import {deepIncludesArray} from '../index'
+
+describe('Deep Includes', () => {
+  test('it should return the correct value', () => {
+    const array = [
+      [1, 'two', 3],
+      [4, 'five', 6],
+      [7, 'eight', 9],
+      [10, 'eleven', 12]
+    ]
+
+    expect(deepIncludesArray(array, [1, 'two', 3])).toBe(true)
+    expect(deepIncludesArray(array, [1, 2, 3])).toBe(false)
+  })
+})

src/functions/deep-includes.ts

@@ -0,0 +1,25 @@
+/**
+ * Check if an array exists inside an array
+ *
+ * @param array The arraay of arrays to check
+ * @param compare The array to check for existance of
+ * @returns `true` id the exact array matches, `false` if not.
+ */
+export const deepIncludesArray = <T extends any[]>(
+  array: T[],
+  compare: T
+): boolean => {
+  return array.reduce<boolean>((includes, value) => {
+    if (includes) {
+      return true
+    }
+
+    return value.reduce<boolean>((match, v, i) => {
+      if (!match) {
+        return false
+      }
+
+      return v === compare[i]
+    }, true)
+  }, false)
+}

src/index.ts

@@ -24,6 +24,7 @@ export {
   numberToVh,
   numberToVw
 } from './functions/css'
+export {deepIncludesArray} from './functions/deep-includes'
 export {defaults} from './functions/defaults'
 export {diffArray} from './functions/diff-array'
 export {diffObject} from './functions/diff-object'