@types/sort-keys-length
v2.0.0
Published
TypeScript definitions for sort-keys-length
Readme
Installation
npm install --save @types/sort-keys-length
Summary
This package contains type definitions for sort-keys-length (https://github.com/kevva/sort-keys-length).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sort-keys-length.
index.d.ts
/**
* Options for sorting object keys by length.
*/
interface SortKeysLengthOptions {
/**
* Recursively sort keys.
* @default false
*/
deep?: boolean;
}
/**
* Sort object keys by length in ascending order (shortest first).
*
* @param object - Object to sort
* @param options - Sort options
* @returns A new object with keys sorted by length in ascending order
*
* @example
* ```javascript
* sortKeysLength.asc({ab: 'x', a: 'y', abc: 'z'});
* //=> {a: 'y', ab: 'x', abc: 'z'}
* ```
*/
declare function asc<T extends object>(object: T, options?: SortKeysLengthOptions): T;
/**
* Sort object keys by length in descending order (longest first).
*
* @param object - Object to sort
* @param options - Sort options
* @returns A new object with keys sorted by length in descending order
*
* @example
* ```javascript
* sortKeysLength.desc({ab: 'x', a: 'y', abc: 'z'});
* //=> {abc: 'z', ab: 'x', a: 'y'}
* ```
*/
declare function desc<T extends object>(object: T, options?: SortKeysLengthOptions): T;
export { asc, desc, SortKeysLengthOptions };
Additional Details
- Last updated: Thu, 05 Feb 2026 08:45:22 GMT
- Dependencies: none
Credits
These definitions were written by gaspard.
