🤖 Merge PR DefinitelyTyped#74467 Add types for sort-keys-length by @gasp

Author: gasp

types/sort-keys-length/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/sort-keys-length/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 };

types/sort-keys-length/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/sort-keys-length",
+    "version": "2.0.9999",
+    "projects": [
+        "https://github.com/kevva/sort-keys-length"
+    ],
+    "devDependencies": {
+        "@types/sort-keys-length": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "gaspard",
+            "githubUsername": "gasp"
+        }
+    ]
+}

types/sort-keys-length/sort-keys-length-tests.ts

@@ -0,0 +1,30 @@
+import { asc, desc } from "sort-keys-length";
+
+// Test ascending sort
+const ascResult = asc({ ab: "x", a: "y", abc: "z" });
+
+// Test descending sort
+const descResult = desc({ ab: "x", a: "y", abc: "z" });
+
+// Test with deep option
+const deepAsc = asc({ ab: "x", a: "y" }, { deep: true });
+const deepDesc = desc({ ab: "x", a: "y" }, { deep: false });
+
+// Test with nested objects
+const nested = asc({
+    longKey: {
+        short: 1,
+        longerKey: 2,
+    },
+    a: "value",
+}, { deep: true });
+
+// Type preservation
+interface MyObject {
+    foo: string;
+    barbaz: number;
+}
+
+const typed: MyObject = { foo: "hello", barbaz: 42 };
+const sortedTyped: MyObject = asc(typed);
+const sortedTypedDesc: MyObject = desc(typed);

types/sort-keys-length/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "sort-keys-length-tests.ts"
+    ]
+}