R
fn

useArrayFilter

v0.0.15testeddemo

Reactive `Array.prototype.filter`.

Example

ts
const list = ref([1, 2, 3, 4]);
const even = useArrayFilter(list, n => n % 2 === 0); // [2, 4]

Demo

Loading demo…

Signature

ts
export function useArrayFilter<T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  fn: (element: T, index: number, array: T[]) => boolean,
): ComputedRef<T[]>{ ... }

Type Parameters

T

Parameters

ParameterTypeDescription
listMaybeRefOrGetter<MaybeRefOrGetter<T>[]>The source array (items can be reactive)
fn(element: T, index: number, array: T[]) => booleanPredicate

Returns

ComputedRef<T[]>The filtered array