nhb-toolbox/dist/dts/array/sort.d.ts

A versatile collection of smart, efficient, and reusable utility functions and classes for everyday development needs.

import type { GenericObject } from '../object/types';
import type { OrderOption, SortByOption } from './types';
/**
 * * Sorts an array of objects.
 *
 * - Sorts array by the specified field.
 *
 * @param array - The array of objects to sort.
 * @param options - Sorting options.
 * @returns The sorted array.
 */
export declare function sortAnArray<T extends GenericObject>(array: T[], options: SortByOption<T>): T[];
/**
 * * Sorts an array of `strings`, `numbers` or `boolean`.
 *
 * @param array - The array of `strings`, `numbers` or `boolean` to sort.
 * @param options - Sorting options.
 * @returns  The sorted array.
 */
export declare function sortAnArray<T extends string | number | boolean>(array: T[], options?: OrderOption): T[];
//# sourceMappingURL=sort.d.ts.map