⬅️ Back to Table of Contents

📄 useArrayIncludes

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	6
🟢 Vue Composition API	1
📐 Interfaces	1
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/useArrayIncludes/index.ts

📦 Imports

Name	Source
ComputedRef	vue
MaybeRefOrGetter	vue
computed	vue
toValue	vue
containsProp	../utils
isObject	../utils

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none

---

Functions

useArrayIncludes(list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>, value: MaybeRefOrGetter<V>, comparator: UseArrayIncludesComparatorFn<T, V>): UseArrayIncludesReturn

Reactive Array.includes

Returns: undefined true if the value is found in the array. Otherwise, false.

See: https://vueuse.org/useArrayIncludes

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive `Array.includes`
 *
 * @see https://vueuse.org/useArrayIncludes
 *
 * @returns true if the `value` is found in the array. Otherwise, false.
 *
 * @__NO_SIDE_EFFECTS__
 */

Code

export function useArrayIncludes<T, V = any>(
  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
  value: MaybeRefOrGetter<V>,
  comparator?: UseArrayIncludesComparatorFn<T, V>,
): UseArrayIncludesReturn

isArrayIncludesOptions(obj: any): obj is UseArrayIncludesOptions<T, V>

Parameters:

• obj any

Returns: obj is UseArrayIncludesOptions<T, V>

Calls:

• isObject (from ../utils)
• containsProp (from ../utils)

Code

function isArrayIncludesOptions<T, V>(obj: any): obj is UseArrayIncludesOptions<T, V> {
  return isObject(obj) && containsProp(obj, 'formIndex', 'comparator')
}

---

Interfaces

UseArrayIncludesOptions<T, V>

Interface Code

export interface UseArrayIncludesOptions<T, V> {
  fromIndex?: number
  comparator?: UseArrayIncludesComparatorFn<T, V> | keyof T
}

Properties

Name	Type	Optional	Description
fromIndex	number	✓	not shown
comparator	UseArrayIncludesComparatorFn<T, V> \| keyof T	✓	not shown

---

Type Aliases

UseArrayIncludesComparatorFn<T, V>

type UseArrayIncludesComparatorFn<T, V> = ((element: T, value: V, index: number, array: MaybeRefOrGetter<T>[]) => boolean);

UseArrayIncludesReturn

type UseArrayIncludesReturn = ComputedRef<boolean>;

---

Generated by Syntax Scribe