useArrayFindIndex

v0.0.15testeddemo

Reactive `Array.prototype.findIndex`.

Example

const list = ref([1, 2, 3]);
const index = useArrayFindIndex(list, n => n > 1); // 1

Demo

Loading demo…

Signature

export function useArrayFindIndex<T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  fn: (element: T, index: number, array: T[]) => unknown,
): UseArrayFindIndexReturn{ ... }

Type Parameters

T

Parameters

Parameter	Type	Default	Description
`list`	`MaybeRefOrGetter<MaybeRefOrGetter<T>[]>`	—	The source array (items can be reactive)
`fn`	`(element: T, index: number, array: T[]) => unknown`	—	Predicate testing each element

Returns

UseArrayFindIndexReturnThe index of the first matching element, or `-1` if none match