feat(useArrayIncludes): new function

packages/shared/index.ts

@@ -35,6 +35,7 @@ export * from './useArrayEvery'
 export * from './useArrayFilter'
 export * from './useArrayFind'
 export * from './useArrayFindIndex'
+export * from './useArrayIncludes'
 export * from './useArrayJoin'
 export * from './useArrayMap'
 export * from './useArrayReduce'

packages/shared/useArrayIncludes/index.md

@@ -0,0 +1,22 @@
+---
+category: Array
+---
+
+# useArrayIncludes
+
+Reactive `Array.includes`
+
+## Usage
+
+### Use with reactive array
+
+```js
+import { useArrayIncludes } from '@vueuse/core'
+const list = ref([0, 2, 4, 6, 8])
+const result = useArrayIncludes(list, 10)
+// result.value: false
+list.value.push(10)
+// result.value: true
+list.value.pop()
+// result.value: false
+```

packages/shared/useArrayIncludes/index.test.ts

@@ -0,0 +1,18 @@
+import { ref } from 'vue-demi'
+import { useArrayIncludes } from './index'
+
+describe('useArrayIncludes', () => {
+  it('should be defined', () => {
+    expect(useArrayIncludes).toBeDefined()
+  })
+
+  it('should work with array of refs', () => {
+    const array = ref([0, 2, 4, 6])
+    const result = useArrayIncludes(array, 8)
+    expect(result.value).toBeFalsy()
+    array.value.push(8)
+    expect(result.value).toBeTruthy()
+    array.value.pop()
+    expect(result.value).toBeFalsy()
+  })
+})

packages/shared/useArrayIncludes/index.ts

@@ -0,0 +1,20 @@
+import type { ComputedRef } from 'vue-demi'
+import { computed } from 'vue-demi'
+import type { MaybeComputedRef } from '../utils'
+import { resolveUnref } from '../resolveUnref'
+
+/**
+ * Reactive `Array.includes`
+ *
+ * @see https://vueuse.org/useArrayIncludes
+ * @param {Array} list - the array was called upon.
+ * @param searchElement - the value to search for.
+ *
+ * @returns {boolean} true if the `searchElement` is found in the array. Otherwise, false.
+ */
+export function useArrayIncludes<T>(
+  list: MaybeComputedRef<MaybeComputedRef<T>[]>,
+  searchElement: T,
+): ComputedRef<boolean> {
+  return computed(() => resolveUnref(list).includes(searchElement))
+}