super-utils-plus/dist/array/drop.d.ts

A superior alternative to Lodash with improved performance, TypeScript support, and developer experience

/**
 * Creates a slice of array with n elements dropped from the beginning.
 *
 * @param array - The array to query
 * @param n - The number of elements to drop
 * @returns The slice of array
 *
 * @example
 * ```ts
 * drop([1, 2, 3]);
 * // => [2, 3]
 *
 * drop([1, 2, 3], 2);
 * // => [3]
 *
 * drop([1, 2, 3], 5);
 * // => []
 *
 * drop([1, 2, 3], 0);
 * // => [1, 2, 3]
 * ```
 */
export declare function drop<T>(array: T[], n?: number): T[];
/**
 * Creates a slice of array with n elements dropped from the end.
 *
 * @param array - The array to query
 * @param n - The number of elements to drop
 * @returns The slice of array
 *
 * @example
 * ```ts
 * dropRight([1, 2, 3]);
 * // => [1, 2]
 *
 * dropRight([1, 2, 3], 2);
 * // => [1]
 *
 * dropRight([1, 2, 3], 5);
 * // => []
 *
 * dropRight([1, 2, 3], 0);
 * // => [1, 2, 3]
 * ```
 */
export declare function dropRight<T>(array: T[], n?: number): T[];
/**
 * Creates a slice of array excluding elements dropped from the beginning.
 * Elements are dropped until predicate returns falsey.
 *
 * @param array - The array to query
 * @param predicate - The function invoked per iteration
 * @returns The slice of array
 *
 * @example
 * ```ts
 * const users = [
 *   { 'user': 'barney',  'active': false },
 *   { 'user': 'fred',    'active': false },
 *   { 'user': 'pebbles', 'active': true }
 * ];
 *
 * dropWhile(users, function(o) { return !o.active; });
 * // => objects for ['pebbles']
 *
 * // The `_.matches` iteratee shorthand.
 * dropWhile(users, { 'user': 'barney', 'active': false });
 * // => objects for ['fred', 'pebbles']
 * ```
 */
export declare function dropWhile<T>(array: T[], predicate: (value: T, index: number, array: T[]) => boolean): T[];
/**
 * Creates a slice of array excluding elements dropped from the end.
 * Elements are dropped until predicate returns falsey.
 *
 * @param array - The array to query
 * @param predicate - The function invoked per iteration
 * @returns The slice of array
 *
 * @example
 * ```ts
 * const users = [
 *   { 'user': 'barney',  'active': true },
 *   { 'user': 'fred',    'active': false },
 *   { 'user': 'pebbles', 'active': false }
 * ];
 *
 * dropRightWhile(users, function(o) { return !o.active; });
 * // => objects for ['barney']
 * ```
 */
export declare function dropRightWhile<T>(array: T[], predicate: (value: T, index: number, array: T[]) => boolean): T[];