@newdash/newdash/remove.d.ts

javascript/typescript utility library

import { CollectionIteratee } from "./types";
/**
 * Removes all elements from `array` that `predicate` returns truthy for
 * and returns an array of the removed elements. The predicate is invoked
 * with three arguments: (value, index, array).
 *
 * **Note:** Unlike `filter`, this method mutates `array`. Use `pull`
 * to pull elements from an array by value.
 *
 * @since 5.11.0
 * @category Array
 * @param {Array} array The array to modify.
 * @param {Function} predicate The function invoked per iteration.
 * @returns {Array} Returns the new array of removed elements.
 * @see [[pull]], [[pullAll]], [[pullAllBy]], [[pullAllWith]], [[pullAt]], [[reject]], [[filter]]
 * @example
 *
 * ```js
 * const array = [1, 2, 3, 4]
 * const evens = remove(array, n => n % 2 == 0)
 *
 * console.log(array)
 * // => [1, 3]
 *
 * console.log(evens)
 * // => [2, 4]
 * ```
 */
export declare function remove<T>(array: ArrayLike<T>, predicate: CollectionIteratee<T, boolean>): Array<T>;
export default remove;