Make KeyPaths not require @ts-ignore (#1842)

* Fix type of KeyPaths to not require ts-ignore * Only recursive into records in KeyPaths * Fix imports in keypaths test * Add patch changeset for KeyPaths
primer · Feb 7, 2022 · 11011f5 · 11011f5
1 parent 1088ee3
commit 11011f5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/.changeset/modern-humans-type.md b/.changeset/modern-humans-type.md
@@ -0,0 +1,5 @@
+---
+'@primer/react': patch
+---
+
+Allow `KeyPaths` type to accept any type in order to remove need for `// @ts-ignore` internally.
diff --git a/src/utils/types/KeyPaths.ts b/src/utils/types/KeyPaths.ts
@@ -1,10 +1,4 @@
 // Produces a union of dot-delimited keypaths to the string values in a nested object:
-export type KeyPaths<O extends Record<string, unknown>> = {
-  [K in keyof O]: K extends string
-    ? O[K] extends string
-      ? `${K}`
-      : // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore TypeScript has bested me, but the KeyPaths type is tested.
-        `${K}.${KeyPaths<O[K]>}`
-    : never
+export type KeyPaths<O> = {
+  [K in keyof O]: K extends string ? (O[K] extends Record<string, unknown> ? `${K}.${KeyPaths<O[K]>}` : `${K}`) : never
 }[keyof O]