fix(useArrayFilter): match type to Array.prototype.filter (#4175)

Jesse205 · web-flow · commit 71fd1408ce34 · 2024-09-16T08:44:26.000Z
diff --git a/packages/shared/useArrayFilter/index.test.ts b/packages/shared/useArrayFilter/index.test.ts
@@ -27,4 +27,10 @@ describe('useArrayFilter', () => {
     list.value.shift()
     expect(result.value).toStrictEqual([2, 4, 6, 8])
   })
+
+  it('should allow values other than boolean in fn', () => {
+    const list = ref([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
+    const result = useArrayFilter(list, i => i % 2)
+    expect(result.value).toStrictEqual([1, 3, 5, 7, 9])
+  })
 })
diff --git a/packages/shared/useArrayFilter/index.ts b/packages/shared/useArrayFilter/index.ts
@@ -12,9 +12,17 @@ import { toValue } from '../toValue'
  *
  * @returns a shallow copy of a portion of the given array, filtered down to just the elements from the given array that pass the test implemented by the provided function. If no elements pass the test, an empty array will be returned.
  */
+export function useArrayFilter<T, S extends T>(
+  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
+  fn: (element: T, index: number, array: T[]) => element is S,
+): ComputedRef<S[]>
+export function useArrayFilter<T>(
+  list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
+  fn: (element: T, index: number, array: T[]) => unknown,
+): ComputedRef<T[]>
 export function useArrayFilter<T>(
   list: MaybeRefOrGetter<MaybeRefOrGetter<T>[]>,
-  fn: (element: T, index: number, array: T[]) => boolean,
+  fn: (element: T, index: number, array: T[]) => unknown,
 ): ComputedRef<T[]> {
   return computed(() => toValue(list).map(i => toValue(i)).filter(fn))
 }
