TypeScript：将函数返回值定义为一种读取对象路径的类型

Question

我想创建一个简单的辅助函数来从这样的对象中读取路径：

interface Human {
  address: {
    city: {
      name: string;
    }
  }
}

const human: Human = { address: { city: { name: "Town"}}};
getIn<Human>(human, "address.city.name"); // Returns "Town"

这个助手在 JS 中很容易创建，但在 TS 中使其类型安全有点复杂。我已经走到这一步了：

type Prev = [never, 0, 1, 2, 3, 4, 5, 6, ...0[]];

type Join<K, P> = K extends string | number
  ? P extends string | number
    ? `${K}${"" extends P ? "" : "."}${P}`
    : never
  : never;

type Path<T, D extends number = 4> = [D] extends [never]
  ? never
  : T extends object
  ? {
      [K in keyof T]-?: K extends string | number
        ? `${K}` | Join<K, Path<T[K], Prev[D]>>
        : never;
    }[keyof T]
  : "";

function getIn<T extends Record<string, any>>(object: T, path: Path<T>): T {
  const parts = path.split(".");
  return parts.reduce<T>((result, key) => {
    if (result !== undefined && result[key]) {
      return result[key];
    }

    return undefined;
  }, object);
}

这行得通，但这里的错误是getIn 的返回类型不应该是T，而是T 中的某些内容，具体取决于给定的路径。所以如果这样调用：

getIn<Human>(human, "address.city.name"); // Returns "Town"

TypeScript 现在应该返回值是一个字符串，如 Human 接口中定义的那样。如果给定"address.city"，返回类型应该是City等。

有什么方法可以使其类型安全吗？

Answer 1

我主要关心的是为getIn() 的呼叫签名设置正确的类型。它将是一个涉及recursive conditional types的generic调用签名，使用template literal types解析和操作字符串literal types。编译器无法验证返回值是否可分配给如此复杂的类型，因此实现将需要一个或多个 type assertions 以避免错误。所有这一切意味着：在实现功能时要小心，确保你做对了；编译器不会发现错误，因为在编译之前你会放弃 as any 。

这是基本计划：

declare function getIn<T extends object, K extends ValidatePath<T, K>>(
  object: T,
  path: K
): DeepIdx<T, K>;

这个想法是我们将定义两种实用程序类型：

• ValidatePath<T, K> 将采用一个对象类型 T 和一个字符串类型 K 表示指向 T 属性的虚线路径。如果 K 是有效的T 的路径，那么 ValidatePath<T, K> 将等同于 K。如果它是一个无效的T 的路径，然后ValidatePath<T, K> 将是一些有效路径，它“接近”K，对于“关闭”的某些定义。希望我们可以 constrain K extends ValidatePath<T, K> 以便接受有效路径，无效路径将生成一条错误消息，提示有效路径。

• DeepIdx<T, K> 将采用对象类型 T 和字符串类型 K 表示指向 T 属性的点路径，然后 DeepIdx<T, K> 将是 T 在路径 @987654350 处的属性类型@.

在我们定义它们之前，我们必须修复调用签名。编译器几乎肯定会抱怨 K extends ValidatePath<T, K> 是无效的循环约束。我们可以解决这个问题，方法是仅将 K 限制为 string，然后为 path 参数编写一个（相当丑陋的）条件类型，它将评估为所需的 ValidatePath<T, K>。它看起来像这样：

declare function getIn<T extends object, K extends string>(
  object: T,
  path: K extends ValidatePath<T, K> ? K : ValidatePath<T, K>
): DeepIdx<T, K>;

---

好的，现在实现：

type ValidatePath<T, K extends string> =
  K extends keyof T ? K :
  K extends `${infer K0}.${infer KR}` ?
  K0 extends keyof T ? `${K0}.${ValidatePath<T[K0], KR>}` : Extract<keyof T, string>
  : Extract<keyof T, string>

type DeepIdx<T, K extends string> =
  K extends keyof T ? T[K] :
  K extends `${infer K0}.${infer KR}` ?
  K0 extends keyof T ? DeepIdx<T[K0], KR> : never
  : never

在这两种情况下，我们都会遍历K。如果K 是T 的键，那么它是一个有效路径，我们正在查看T[K] 属性。如果K是一个点路径，那么我们看第一个点之前的部分K0。如果这是T 的键，那么第一部分是有效路径，我们需要递归到T[K0]，第一个点之后的部分KR 的路径。如果K0是不是T 的键，那么我们有一个无效路径，因此 Extract<keyof T, string> 是“关闭”有效路径（使用 the Extract<T, U> utility type 丢弃任何非字符串键）。如果 K 既不是 T 的键也不是虚线路径，那么它是无效的，所以 Extract<keyof T, string> 也是“关闭”有效路径。

---

好吧，让我们测试一下：

const human: Human = { address: { city: { name: "Town" } } };
const addr = getIn(human, "address");
// const addr: { city: { name: string; }; }
console.log(addr) // {city: {name: "Town"}}
const city = getIn(human, "address.city");
// const city: { name: string; }
console.log(city) // {name: "Town"}
const town = getIn(human, "address.city.name");
// const town: string
console.log(town) // "Town"

getIn(human, "address.city.neam"); // error!
// Argument of type '"address.city.neam"' is not 
// assignable to parameter of type '"address.city.name"'

getIn(human, ""); // error!
// Argument of type '""' is not assignable to 
// parameter of type '"address"'

getIn({ a: 1, b: 2, c: 3 }, "z") // error!
// Argument of type '"z"' is not assignable to 
// parameter of type '"a" | "b" | "c"'.

看起来不错。接受所有有效路径，并且输出类型正确。同时，无效路径都会产生错误，这些错误会建议正确的路径应该是什么。

Playground link to code