如何编写启用 no-unsafe-any 的类型保护？

Question

我正在尝试通过使用更严格的 lint 规则集来收紧我的 TS 代码，但我正在努力解决什么应该是合法的动态用途。

我正在制作一个类型保护来检测某些东西是否是可迭代的（如果不是，则将其包装在一个数组中），除了抑制 lint 规则以告诉它是 kosher 之外，我不知道要告诉 TS 什么：

function isIterable(obj: any): obj is Iterable<unknown> {
    return obj && typeof obj[Symbol.iterator] === 'function';
}

我尝试将其更改为：

function isIterable(obj: undefined | {[Symbol.iterator]?: unknown}): obj is Iterable<unknown> {
    return !!obj && typeof obj[Symbol.iterator] === 'function';
}

它编译时不使用any，但它没有用，因为我想将未知类型的值传递给它。

是否有一种“干净”的方式来表示“是的，我实际上想依靠 JS 返回 undefined 来访问对象上不存在的属性”？特别是。因为这是编写类型保护的重点。

Answer 1

我不知道在user-defined type guard 的实现中，像 no-unsafe-any 这样的东西是否会让你买太多，因为通常这种类型保护的全部意义在于允许编译器通过内置的控制流缩小来缩小通常无法做到的值。我当然会理解在这样的实现中暂停一条 linter 规则。

但我认为您几乎可以像这样获得您正在寻找的行为：

function isIterable(obj: unknown): obj is Iterable<unknown> {
  if ((typeof obj !== 'object') || (obj === null)) return false; 
  // obj is now type object
  const wObj: { [Symbol.iterator]?: unknown } = obj; // safely widen to wObj
  return typeof wObj[Symbol.iterator] === 'function'; 
}

这是一些需要跳过的环节，但我们的想法是使用控制流缩小将unknown缩小到object，然后将object专门扩大到具有您要检查的可选属性的类型（这通过引入一个新变量来实现）。最后，检查扩展类型上该属性的类型。由于您要检查的属性键是符号类型，因此您需要在扩展类型中提及特定的属性名称。如果属性键是字符串，您可以使用string index signature：

function isPromise(obj: unknown): obj is Promise<unknown> {
  if ((typeof obj !== 'object') || (obj === null)) return false;
  // obj is now type object
  const wObj: {[k: string]: unknown} = obj; // safely widen to wObj
  return typeof wObj.then === 'function';
}

无论如何，我希望这能让你更接近你的目标。祝你好运！

Answer 2

另一个好的策略是使用Partial 和as 演员表。

interface RegularForm {
    regular: number;
}

interface FancyForm extends RegularForm {
    fancy: string;
}

const isFancyForm = (instance: RegularForm): instance is FancyForm =>
    (instance as Partial<FancyForm>).fancy !== undefined;