made-collections/array/index.d.ts

This package includes:

/**
 * Updates an item within the array, if the item exists.
 * @param {T[]} array - The array to update the item in.
 * @param {T} item - The item to update.
 * @param {(item: T) => boolean} predicate - The function to find the item within the array.
 * @return {boolean} True if the item was updated; otherwise, false.
 */
export declare function update<T>(array: T[], item: T, predicate: (item: T) => boolean): boolean;
/**
 * Makes the given destination array items equal to the items in the given source array.
 * @param {T[]} destination - The destination array to make equal to the source.
 * @param {T[]} source - The source array to provide the items.
 * @return {T[]} The updated destination array.
 */
export declare function makeEqualTo<T>(destination: T[], source: T[]): T[];
/**
 * Adds an array of items to another.
 * @param {T[]} destination - The destination array to add items from the source to.
 * @param {T[]} itemsToAdd - The source array items to add.
 * @return {T[]} The updated destination array.
 */
export declare function addRange<T>(destination: T[], itemsToAdd: T[]): T[];
/**
 * Removes an array of existing items from another.
 * @param {T[]} destination - The destination array to remove items from.
 * @param {T[]} itemsToAdd - The source array items to remove that should exist in the destination array.
 * @return {T[]} The updated destination array.
 */
export declare function removeRange<T>(destination: T[], itemsToRemove: T[]): T[];
/**
 * Determines whether two arrays are equivalent, containing all the same items with no regard to order.
 * @param {T[]} expected - The array of expected items.
 * @param {T[]} actual - The array of actual items.
 * @return {boolean} True if the arrays are equivalent; otherwise, false.
 */
export declare function areEquivalent<T>(expected: T[], actual: T[]): boolean;
/**
 * Takes a number of elements from the specified array from the specified starting index.
 * @param {T[]} array - The array of of items to take from.
 * @param {number} startIndex - The index to start at in the array.
 * @param {number} count - The number of items to take from the starting index.
 * @return {T[]} An array subset of the specified array.
 */
export declare function takeFromIndex<T>(array: T[], startIndex: number, count: number): T[];
/**
 * Chunks an array of items into an array of arrays grouped into the specified chunk size.
 * @param {T[]} array - The array of items to chunk.
 * @param {number} size - The size of the chunks.
 * @return {T[][]} An array of arrays containing the chunked items.
 */
export declare function chunk<T>(array: T[], size: number): T[][];
/**
 * Gets the potential index of an item that does not currently exist within an array based on the specified criteria.
 * @param {T[]} array - The array of items to get the potential index from.
 * @param {T} value - The object to insert into the array.
 * @param {(value: T, item: T) => boolean} predicate - The function to determine the position of the item based on the provided value.
 * @return {number} The potential index of the item in the array.
 */
export declare function potentialIndexOf<T>(array: T[], value: T, predicate: (value: T, item: T) => boolean): number;
/**
 * Inserts an item to the specified array at the potential index determined by the predicate.
 * @param {T[]} array - The array of items the item should be inserted into.
 * @param {T} value - The object to insert into the array.
 * @param {(value: T, item: T) => boolean} predicate - The function to determine the position of the item based on the provided value.
 * @return {number} The inserted index of the item in the array.
 */
export declare function insertAtPotentialIndex<T>(array: T[], value: T, predicate: (value: T, item: T) => boolean): number;
/**
 * Creates a new array from the specified and shuffles the elements randomly.
 * @param {T[]} array - The array of items to shuffle.
 * @return {T[]} The new shuffled array of items.
 */
export declare function shuffle<T>(array: T[]): T[];