如何在 TypeScript 中创建一个类型来检索对象的所有键

php中文网 2024-10-15 11:51:23

typescript 有一个名为 keyof 的功能，可用于获取对象的键。然而，keyof 运算符仅适用于对象的第一层，当我们想要获取深层的所有键时，事情会变得有点复杂。在这篇文章中，我们将讨论如何实现一个可以深层获取所有键的类型。

问题概述

为了理解我们要解决的问题，让我们从一个例子开始。考虑以下对象：

const obj = {
  a: {
    b: 1,
    c: {
      d: 2,
      e: 3
    }
  },
  f: {
    g: 4
  }
}

如果我们想要获取这个对象的所有键，包括嵌套对象中的键，我们需要一个可以递归遍历该对象并返回所有键的类型。这可能是一项具有挑战性的任务，特别是对于具有多层嵌套的复杂对象。

可能的解决方案

解决此问题的一种方法是使用递归类型定义。 typescript 允许我们使用交集类型定义递归类型。交集类型是表示具有交集中所有类型的所有属性的值的类型。

我们可以定义一个递归类型来表示具有一组键的对象，其中每个键要么是一个原始值，要么是另一个也具有一组键的对象。下面是我们如何定义这种类型：

type deepkeys<t> = t extends object
  ? {
      [k in keyof t]-?: k extends string | number
        ? `${k}` | `${k}.${deepkeys<t>}`
        : never;
    }[keyof t]
  : never;
</t></t>

这个类型定义可能看起来有点复杂，所以让我们把它分解成更小的部分。

类型 deepkeys 是一个条件类型，用于检查输入类型 t 是否为对象。如果 t 是一个对象，我们使用映射类型创建一个与 t 具有相同键的新对象，但值是嵌套对象的键，表示为字符串。如果 t 不是对象，我们返回一个空字符串。

映射类型使用 keyof 运算符来获取对象的键，然后我们使用条件语句来检查每个键是否是字符串或数字。如果键是字符串或数字，我们将其与点和嵌套对象的键连接起来，使用 deepkeys 递归获得。如果密钥不是字符串或数字，我们将返回 never，这意味着密钥无效。

使用类型

现在我们已经定义了 deepkeys 类型，我们可以使用它来获取任何具有嵌套对象的对象的键。这是我们如何使用它的示例：

const obj = {
  a: {
    b: 1,
    c: {
      d: 2,
      e: 3,
    },
  },
  f: {
    g: 4,
  },
  h: undefined,
};

type DeepKeys<t> = T extends object
  ? {
      [K in keyof T]-?: K extends string | number
        ? `${K}` | `${K}.${DeepKeys<t>}`
        : never;
    }[keyof T]
  : never;

function getAllKeys<t extends object>(
  obj: T,
  prefix: string = '',
): DeepKeys<t>[] {
  return Object.entries(obj).reduce((result: string[], [key, value]) =&gt; {
    const newPrefix = prefix ? `${prefix}.${key}` : key;

    return result.concat([
      newPrefix,
      ...(typeof value === 'object' &amp;&amp; value !== null
        ? getAllKeys(value, newPrefix)
        : []),
    ]);
  }, []) as DeepKeys<t>[];
}

const keys = getAllKeys(obj);
console.log(keys); // ["a" | "f" | "h" | "a.b" | "a.c" | "a.c.d" | "a.c.e" | "f.g"]
</t></t></t></t></t>

在此示例中，我们定义了一个名为 getallkeys 的函数，该函数将一个对象作为参数并返回该对象中所有键的数组。我们使用 object.keys 方法获取对象的键，然后将结果转换为 deepkeys 类型，以确保我们获取所有键，包括嵌套对象中的键。