feat(filterfirst): deprecate filterFirst function in favour of exclud…

…eFirst This function is confusing. Use excludeFirst instead, and invert the predicate.
softwareventures · Oct 9, 2022 · c7d1fc8 · c7d1fc8
1 parent 94feefd
commit c7d1fc8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/index.ts b/index.ts
@@ -325,6 +325,8 @@ export function filterFn<T>(
     return array => nativeFilter.call(array, predicate) as T[];
 }
 
+/** @deprecated This function is confusing, use {@link excludeFirst} instead,
+ * and invert the predicate. */
 export function filterFirst<T>(
     array: ArrayLike<T>,
     predicate: (element: T, index: number) => boolean
@@ -345,6 +347,8 @@ export function filterFirst<T>(
     return result;
 }
 
+/** @deprecated This function is confusing, use {@link excludeFirstFn} instead,
+ * and invert the predicate. */
 export function filterFirstFn<T>(
     predicate: (element: T, index: number) => boolean
 ): (array: ArrayLike<T>) => T[] {