Typescript用户定义的类型保护检查对象具有数组中的所有属性

Ric*_*ler 3 typescript typeguards

我正在尝试编写一个用户定义的类型保护来测试给定的值是否具有给定数组中的所有属性。

我调用这个函数hasAll,它在 Javascript 中的实现和用法如下所示:

function hasAll(obj, keysToCheck) {
  if (!obj) return false;

  for (const key of keysToCheck) {
    const value = obj[key];
    if (value === null) return false;
    if (value === undefined) return false;
  }

  return true;
}

hasAll({ foo: 'test', bar: 5 }, ['foo', 'bar']); // true

hasAll({ foo: 'test', bar: 5 }, ['foo', 'bar', 'baz']); // false
Run Code Online (Sandbox Code Playgroud)

我现在想做的是将上面的函数变成类型保护。这是我到目前为止所拥有的:

// this _almost_ works 
type Nullable<T> = T | null | undefined;

type RemoveNullables<T, K extends keyof T> = {
  [P in K]-?: T[P] extends Nullable<infer U> ? U : T[P];
};

function hasAll<T, K extends keyof NonNullable<T>>(
  obj: T,
  keysToCheck: K[],
): obj is RemoveNullables<NonNullable<T>, K> {
  // but i'm getting an error here 
  if (!obj) return false;

  const nonNullableObj = obj as NonNullable<T>;

  for (const key of keysToCheck) {
    const value = nonNullableObj[key];
    if (value === null) return false;
    if (value === undefined) return false;
  }

  return true;
}

export default hasAll;
Run Code Online (Sandbox Code Playgroud)

游乐场链接


错误信息是:

A type predicate's type must be assignable to its parameter's type.
  Type 'RemoveNullables<NonNullable<T>, K>' is not assignable to type 'T'.
Run Code Online (Sandbox Code Playgroud)

我已经阅读了这个答案并给出了很好的解释,但它对我的情况并没有真正帮助。

我想明确断言我的类型在运行此函数后将T符合。RemoveNullables<NonNullable<T>, K>我真的不在乎是否可以T分配给RemoveNullables<NonNullable<T>, K>(如果有意义的话)。


  1. 我在这件事上做错了吗?有没有更好的方法来编写这种类型保护?
  2. 如果这种方法没问题,我如何告诉打字稿我不关心类型保护本身是否“不安全”?

kay*_*ya3 5

这似乎满足您的要求:

type ExcludeNullable<T, K extends keyof NonNullable<T>> = NonNullable<T> & {
    [k in K]-?: Exclude<NonNullable<T>[k], null | undefined>
}

function hasAll<T, K extends keyof NonNullable<T>>(
    obj: T,
    keysToCheck: K[]
): obj is ExcludeNullable<T, K> {
    return obj !== null && obj !== undefined
        && keysToCheck.every(k => obj![k] !== null && obj![k] !== undefined);
}
Run Code Online (Sandbox Code Playgroud)

一些注意事项:

  • 交集T & ...类型保证ExcludeNullable<T, K>可以分配给T。如果没有这个,映射类型就不具有T中缺少的属性K
  • Exclude是比使用条件类型更简单的摆脱nulland的方法。undefinedinfer
  • 我冒昧地hasAll稍微简化了函数的实现。

游乐场链接