Typescript函数在特定路径合并对象

Question

我有一个合并功能，可以合并特定路径的对象。

const merge = (src, path, newObj) => {
   // this code works fine
}

要使用这个函数，我这样称呼它：

interface IUser {
   user: {
      address: {
        street: string
      }
   }
}

interface IAddrNum {
   door: number
}

const User: IUser = {
   user: {
     address: {
        street: "New Street"
     }
   }
}


const mergeObj: IAddrNum = {
   door: 59
}

const newObj = merge(User, "user.address", mergeObj);

这样，我得到了正确的结果。

{
   user: {
     address: {
       street: "New Street"
       door: 59
     }
   }
}

问题：我想在 typescript 中为这个函数创建一个签名。

interface Immutable {
   merge<T, K, M>(
     src: T,
     path: K,
     merge: M
   ): T & M // <== this is where the problem is
}

这没有按预期工作。它不能是T & K，因为合并必须发生在特定路径上。是否有可能拥有此功能的签名？如果是这样，你能给我一些方向吗？谢谢。

Answer 1

如果您可以使用路径元组，那么我们需要操作元组。一个有用的类型别名是Tail<T>，它采用像[string, number, boolean] 这样的元组类型并返回另一个删除了第一个元素的元组，比如[number, boolean]：

type Tail<T extends any[]> = 
  ((...t: T) => void) extends ((h: any, ...r: infer R) => void) ? R : never;

然后我们可以写DeepRecord<K, V>，其中K是属性键的路径，V是一些值。我们创建了一个递归映射条件类型，它产生一个对象类型，其中V 位于K 描述的路径中：

type DeepRecord<K extends PropertyKey[], V> =
    K extends [] ? V : { [P in K[0]]: DeepRecord<Tail<K>, V> };

只是为了确保它有效，这里有一个例子"

type Example = DeepRecord<["foo", "bar", "baz"], string>;
/* type Example = { foo: { bar: { baz: string; }; };} */

现在我们基本上已经完成了，但是创建一个递归合并交叉点的东西也很好，这样你就可以得到一个 {foo: {bar: {baz: string; qux: number;}}} 而不是 {foo: {bar: {baz: string; qux: number;}}}：

type MergeIntersection<T> = 
  T extends object ? { [K in keyof T]: MergeIntersection<T[K]> } : T;

最后，我们可以给merge() 一个类型签名（以及一个实现，尽管这超出了问题的范围并且不保证是正确的）：

const merge = <T extends object, K extends N[] | [], 
  V extends object, N extends PropertyKey>(
    src: T, path: K, newObj: V
) => {
    const ret = { ...src } as MergeIntersection<T & DeepRecord<K, V>>;
    let obj: any = ret;
    for (let k of path) {
        if (!(k in obj)) {
            obj[k] = {};
        }
        obj = obj[k];
    }
    Object.assign(obj, newObj);
    return ret;
}

请注意，N 在定义中的作用并不大，但它有助于让编译器推断出path 参数包含literals 而不仅仅是string。 K 约束中的 | [] 有助于编译器推断元组而不是数组。您希望 ["user", "address"] 被推断为 ["user", "address"] 而不是 string[] 类型，否则整个事情就会崩溃。这个烦人的魔法是microsoft/TypeScript#30680 的主题，目前这是我能做的最好的。

您可以在示例代码上对其进行测试：

const newObj = merge(User, ["user", "address"], mergeObj);
/* const newObj: {
    user: {
        address: {
            street: string;
            door: number;
        };
    };
}*/

console.log(JSON.stringify(newObj));
// {"user":{"address":{"street":"New Street","door":59}}}

我认为看起来不错。好的，希望有帮助；祝你好运！

Playground link to code