1---
2category: Array
3---
4 
5# useArrayIncludes
6 
7Reactive `Array.includes`
8 
9## Usage
10 
11### Use with reactive array
12 
13```ts
14import { useArrayIncludes } from '@vueuse/core'
15 
16const list = ref([0, 2, 4, 6, 8])
17const result = useArrayIncludes(list, 10)
18// result.value: false
19list.value.push(10)
20// result.value: true
21list.value.pop()
22// result.value: false
23```
24 
25## Type Declarations
26 
27```ts
28export type UseArrayIncludesComparatorFn<T, V> = (
29  element: T,
30  value: V,
31  index: number,
32  array: MaybeRefOrGetter<T>[],
33) => boolean
34export interface UseArrayIncludesOptions<T, V> {
35  fromIndex?: number
36  comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T
37}
38export type UseArrayIncludesReturn = ComputedRef<boolean>
39/**
40 * Reactive `Array.includes`
41 *
42 * @see https://vueuse.org/useArrayIncludes
43 *
44 * @returns true if the `value` is found in the array. Otherwise, false.
45 *
46 * @__NO_SIDE_EFFECTS__
47 */
48export declare function useArrayIncludes<T, V = any>(
49  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
50  value: MaybeRefOrGetter<V>,
51  comparator?: UseArrayIncludesComparatorFn<T, V>,
52): UseArrayIncludesReturn
53export declare function useArrayIncludes<T, V = any>(
54  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
55  value: MaybeRefOrGetter<V>,
56  comparator?: keyof T,
57): UseArrayIncludesReturn
58export declare function useArrayIncludes<T, V = any>(
59  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
60  value: MaybeRefOrGetter<V>,
61  options?: UseArrayIncludesOptions<T, V>,
62): UseArrayIncludesReturn
63```
64