@shopify/cli-kit/dist/public/common/array.d.ts

A set of utilities, interfaces, and models that are common across all the platform features

import type { List, ValueIteratee } from 'lodash';
/**
 * Takes a random value from an array.
 *
 * @param array - Array from which we'll select a random item.
 * @returns A random element from the array.
 */
export declare function takeRandomFromArray<T>(array: T[]): T;
/**
 * Returns a copy of the array deleting the elemements that are undefined.
 *
 * @param array - The array whose undefined will be deleted.
 * @returns A copy of the array with the undefined elements deleted.
 */
export declare function getArrayRejectingUndefined<T>(array: (T | undefined)[]): T[];
/**
 * Returns true if an array contains duplicates.
 *
 * @param array - The array to check against.
 * @returns True if the array contains duplicates.
 */
export declare function getArrayContainsDuplicates<T>(array: T[]): boolean;
/**
 * Removes duplicated items from an array.
 *
 * @param array - The array to inspect.
 * @returns Returns the new duplicate free array.
 */
export declare function uniq<T>(array: T[]): T[];
/**
 * This method is like `_.uniq` except that it accepts `iteratee` which is
 * invoked for each element in `array` to generate the criterion by which
 * uniqueness is computed. The iteratee is invoked with one argument: (value).
 *
 * @param array - The array to inspect.
 * @param iteratee - The iteratee invoked per element.
 * @returns Returns the new duplicate free array.
 */
export declare function uniqBy<T>(array: List<T> | null | undefined, iteratee: ValueIteratee<T>): T[];
/**
 * Creates an array of `array` values not included in the other provided arrays using SameValueZero for
 * equality comparisons. The order and references of result values are determined by the first array.
 *
 * @param array - The array to inspect.
 * @param values - The arrays of values to exclude.
 * @returns Returns the new array of filtered values.
 */
export declare function difference<T>(array: List<T> | null | undefined, ...values: List<T>[]): T[];
/**
 * Converts an array of anything into a human friendly list.
 *
 * Returns a new array that contains the items separated by commas,
 * except for the last item, which is separated by "and".
 * This is useful for creating human-friendly sentences.
 *
 * @param items - Token[].
 * @returns Token[].
 * @example
 * ```ts
 *   const items = ['apple', 'banana', {command: "--flag"}];
 *   const result = asHumanFriendlyList(items)
 *
 *   // ['apple', ',', 'banana', ',', 'and', {command: "--flag"}]
 *   console.log(result);
 * ```
 */
export declare function asHumanFriendlyArray<T>(items: T[]): (T | string)[];