@rxap/utilities/src/lib/object/sort-properties.d.ts

A collection of utility functions, types and interfaces.

/**
 * Compares two strings using the locale-specific comparison to determine their relative order.
 *
 * This function is typically used as a comparator for sorting arrays of strings in the default
 * lexicographical order according to the current locale settings.
 *
 * @param {string} a - The first string to compare.
 * @param {string} b - The second string to compare.
 * @returns {number} A negative number if `a` comes before `b`, zero if they are equivalent,
 * or a positive number if `a` comes after `b`.
 *
 * @example
 * const strings = ['banana', 'apple', 'cherry'];
 * strings.sort(DefaultSortPropertiesCompareFn); // ['apple', 'banana', 'cherry']
 */
export declare function DefaultSortPropertiesCompareFn(a: string, b: string): number;
/**
 * Sort the properties of an object in place
 * @param obj
 * @param compareFn
 */
export declare function SortProperties<T>(obj: T, compareFn?: (a: string, b: string) => number): T;