TypeScript类型安全的省略功能

时间:2018-12-29 03:41:47

标签: javascript typescript underscore.js lodash ecmascript-7

我想用普通打字稿复制lodash的_.omit函数。 omit应该返回一个对象,该对象的某些属性已删除,这些属性是通过先出现的对象参数之后通过参数指定的。

这是我的最佳尝试:

function omit<T extends object, K extends keyof T>(obj: T, ...keys: K[]): {[k in Exclude<keyof T, K>]: T[k]} {
    let ret: any = {};
    let key: keyof T;
    for (key in obj) {
        if (!(keys.includes(key))) {
            ret[key] = obj[key];
        }
    }
    return ret;
}

哪个给我这个错误:

Argument of type 'keyof T' is not assignable to parameter of type 'K'.
  Type 'string | number | symbol' is not assignable to type 'K'.
    Type 'string' is not assignable to type 'K'.ts(2345)
let key: keyof T

我对错误的解释是:

  1. 由于键是keyof T并且T是对象,所以键可以是symbolnumberstring

  2. 由于我使用了for in循环,因此键只能是string,但是如果我传入数组,则includes可能需要number ?我认为。那意味着这里有类型错误?

任何关于为什么不起作用以及如何使其起作用的见解都将受到赞赏!

5 个答案:

答案 0 :(得分:4)

interface Omit {
    <T extends object, K extends [...(keyof T)[]]>
    (obj: T, ...keys: K): {
        [K2 in Exclude<keyof T, K[number]>]: T[K2]
    }
}

const omit: Omit = (obj, ...keys) => {
    let ret = {} as {
        [K in keyof typeof obj]: (typeof obj)[K]
    };
    let key: keyof typeof obj;
    for (key in obj) {
        if (!(keys.includes(key))) {
            ret[key] = obj[key];
        }
    }
    return ret;
}

为方便起见,我将大多数输入拉到了界面上。

问题在于K被(正确的时态?)推断为 tuple ,而不是按键的 union 。因此,我相应地更改了它的类型约束:

[...(keyof T)[]] // which can be broke down to:
keyof T // a union of keys of T
(keyof T)[] // an array containing keys of T
[] // a tuple
[...X] // a tuple that contains an array X

然后,我们需要将元组K转换为联合(以便从Exclude keyof T进行元组化)。这是通过K[number]完成的,我想这是不言而喻的,它与T[keyof T]创建T的值的并集相同。

Playground

答案 1 :(得分:1)

上面的Nurbol可接受的答案可能是类型更大的版本,但这是我在utils-min中所做的事情。

它使用内置的Oscript打字稿,并且仅支持字符串键名。 (仍然需要放宽Set to Set,但其他一切似乎都可以正常工作)

export function omit<T extends object, K extends Extract<keyof T, string>>(obj: T, ...keys: K[]): Omit<T, K> {
  let ret: any = {};
  const excludeSet: Set<string> = new Set(keys); 
  // TS-NOTE: Set<K> makes the obj[key] type check fail. So, loosing typing here. 

  for (let key in obj) {
    if (!excludeSet.has(key)) {
      ret[key] = obj[key];
    }
  }
  return ret;
}

答案 2 :(得分:0)

如果将键的类型限制为字符串[],则可以使用。 但这似乎不是一个好主意。键应为字符串|编号symbol [];

function omit<T, K extends string>(
  obj: T,
  ...keys: K[]
): { [k in Exclude<keyof T, K>]: T[k] } {
  let ret: any = {};
  Object.keys(obj)
    .filter((key: K) => !keys.includes(key))
    .forEach(key => {
      ret[key] = obj[key];
    });
  return ret;
}
const result = omit({ a: 1, b: 2, c: 3 }, 'a', 'c');
// The compiler inferred result as 
// {
//   b: number;
// }

答案 3 :(得分:0)

Object.keysfor in将键作为字符串返回并排除符号。数字键也将转换为字符串。

您需要将数字字符串键转换为数字,否则它将返回带有字符串键的对象。

function omit<T extends Record<string | number, T['']>,
 K extends [...(keyof T)[]]>(
    obj: T,
    ...keys: K
): { [P in Exclude<keyof T, K[number]>]: T[P] } {
    return (Object.keys(obj)
         .map((key) => convertToNumbers(keys, key)) as Array<keyof T>)
        .filter((key) => !keys.includes(key))
        .reduce((agg, key) => ({ ...agg, [key]: obj[key] }), {}) as {
        [P in Exclude<keyof T, K[number]>]: T[P];
    };
}

function convertToNumbers(
    keys: Array<string | number | symbol>,
    value: string | number
): number | string {
    if (!isNaN(Number(value)) && keys.some((v) => v === Number(value))) {
        return Number(value);
    }

    return value;
}


// without converToNumbers omit({1:1,2:'2'}, 1) will return {'1':1, '2':'2'}
// Specifying a numeric string instead of a number will fail in Typescript

要包含符号,可以使用下面的代码。

function omit<T, K extends [...(keyof T)[]]>(
    obj: T,
    ...keys: K
): { [P in Exclude<keyof T, K[number]>]: T[P] } {
    return (Object.getOwnPropertySymbols(obj) as Array<keyof T>)
        .concat(Object.keys(obj)
        .map((key) => convertToNumbers(keys, key)) as Array<keyof T>)
        .filter((key) => !keys.includes(key))
        .reduce((agg, key) => ({ ...agg, [key]: obj[key] }), {}) as {
        [P in Exclude<keyof T, K[number]>]: T[P];
    };
}

答案 4 :(得分:0)

最简单的方法:

export const omit = <T extends object, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K> => {
  keys.forEach((key) => delete obj[key])
  return obj
}

作为纯函数:

export const omit = <T extends object, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K> => {
  const _ = { ...obj }
  keys.forEach((key) => delete _[key])
  return _
}