将函数返回值定义为读取对象中路径的类型

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()。它将是一个涉及递归条件类型的通用调用签名，该类型使用模板文字类型来解析和操作字符串文字类型。编译器无法验证返回值是否可分配给如此复杂的类型，因此实现将需要一个或多个类型断言来避免错误。所有这些意味着：在实现该功能时要小心，以确保您做得正确；编译器不会发现错误，因为你将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”的某个有效路径。希望我们可以进行限制 K extends ValidatePath<T, K>，以便接受有效路径，而无效路径将生成一条错误消息，提示有效路径。

• DeepIdx<T, K>将采用对象类型和表示 属性的点分路径的T字符串类型，然后将是at path属性的类型。KTDeepIdx<T, K>TK

在定义这些之前，我们必须修复调用签名。编译器几乎肯定会抱怨这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>“关闭”有效路径也是如此（使用实用程序类型丢弃Extract<T, U>任何非字符串键）。如果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 代码链接