useArrayIncludes

v0.0.15testeddemo

Reactive `Array.prototype.includes` with an optional comparator and `fromIndex`. The source array and its items may be reactive.

Source Tests

Examples

const list = ref([1, 2, 3, 4]);
const hasThree = useArrayIncludes(list, 3); // true

const list = ref([{ id: 1 }, { id: 2 }]);
const hasTwo = useArrayIncludes(list, 2, 'id'); // compare by key

const list = ref(['a', 'b', 'a']);
const fromSecond = useArrayIncludes(list, 'a', { fromIndex: 1 }); // true

Demo

Loading demo…

Signatures

export function useArrayIncludes<T, V = T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  value: MaybeRefOrGetter<V>,
  comparator?: UseArrayIncludesComparatorFn<T, V>,
): UseArrayIncludesReturn;

export function useArrayIncludes<T, V = T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  value: MaybeRefOrGetter<V>,
  comparator?: keyof T,
): UseArrayIncludesReturn;

export function useArrayIncludes<T, V = T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  value: MaybeRefOrGetter<V>,
  options?: UseArrayIncludesOptions<T, V>,
): UseArrayIncludesReturn;

Type Parameters

T

V= T

Parameters

Parameter	Type	Default	Description
`list`	`MaybeRefOrGetter<MaybeRefOrGetter<T>[]>`	—	The source array (items can be reactive)
`value`	`MaybeRefOrGetter<V>`	—	The value to search for (may be reactive)
`comparator`?	`UseArrayIncludesComparatorFn<T, V> \| keyof T \| UseArrayIncludesOptions<T, V> \| undefined`	—	A comparator function, a key of `T` to compare by, or an options object with `comparator`/`fromIndex`

Returns

UseArrayIncludesReturnA computed boolean that is `true` when the value is found