mirror of
https://github.com/Tria-plc/emaui.git
synced 2026-08-27 10:52:54 +00:00
22 lines
785 B
TypeScript
22 lines
785 B
TypeScript
//#region src/object/sortKeys.d.ts
|
|
/**
|
|
* Creates a new object with the keys sorted.
|
|
*
|
|
* The keys are sorted alphabetically by default, but a custom compare function can be provided.
|
|
*
|
|
* @template T - The type of the object.
|
|
* @param {T} object - The object to sort keys from.
|
|
* @param {(a: string, b: string) => number} [compareKeys] - A custom compare function for sorting keys.
|
|
* @returns {T} A new object with the keys sorted.
|
|
*
|
|
* @example
|
|
* sortKeys({ b: 2, a: 1, c: 3 });
|
|
* // => { a: 1, b: 2, c: 3 }
|
|
*
|
|
* @example
|
|
* sortKeys({ b: 2, a: 1, c: 3 }, (a, b) => b.localeCompare(a));
|
|
* // => { c: 3, b: 2, a: 1 }
|
|
*/
|
|
declare function sortKeys<T extends Record<string, any>>(object: T, compareKeys?: (a: string, b: string) => number): T;
|
|
//#endregion
|
|
export { sortKeys }; |