如何修复 no-unsafe-any 规则？

Question

我正在使用 TSLint 来检查我的 Angular TypeScript 代码。我启用了no-unsafe-any 规则，因为对我来说，永远不要假设any 类型的属性是一个很好的规则。

问题是该规则在我的某些代码上报告了错误，除了禁用该规则之外，我无法以任何方式修复这些错误。根据以下规则无效的代码示例。

public intercept(request: HttpRequest<{}>, next: HttpHandler): Observable<HttpEvent<{}>> {
  return next
    .handle(request)
    .pipe(
      catchError(error => {
        if (error && error.status === httpCodeUnauthorized) {
          // Auto logout if unathorized
          this.authenticationService.logout();
        }

        const errorMessage = (error.error && error.error.message) || error.statusText;

        return throwError(errorMessage);
      }),
    );
}

Linter 在 2 行报告 4 个错误：

ERROR: /home/robert/programming/npc/gui/src/app/core/authentication/unauthorized.interceptor.ts[24, 24]: Unsafe use of expression of type 'any'.
ERROR: /home/robert/programming/npc/gui/src/app/core/authentication/unauthorized.interceptor.ts[29, 33]: Unsafe use of expression of type 'any'.
ERROR: /home/robert/programming/npc/gui/src/app/core/authentication/unauthorized.interceptor.ts[29, 48]: Unsafe use of expression of type 'any'.
ERROR: /home/robert/programming/npc/gui/src/app/core/authentication/unauthorized.interceptor.ts[29, 72]: Unsafe use of expression of type 'any'

2 个有问题的行是：

• if (error && error.status === httpCodeUnauthorized) {
• const errorMessage = (error.error && error.error.message) || error.statusText;

问题的根源在于catchError（Rxjs 库函数）的处理程序的error 参数具有any 类型。我知道error 可以是任何类型，因此假设它定义了任何属性是不安全的，但我会在实际引用它们之前首先检查这些属性是否存在，这对我来说似乎是安全的。

我可以/应该做什么来让 linter/TypeScript 编译器相信它是安全的并通过规则？

Answer 1

在 Angular 的情况下，错误应该始终属于 HttpErrorResponse 类型

catchError((error: HttpErrorResponse) => {
//...
}

也就是说，在您的代码中，您查看error.error，它在HttpErrorResponse 中定义为any，因此您可能应该使用类型保护来检查并将其转换为错误对象。不是没有必要定义Error - 它应该由打字稿基类型定义。

function isError(value: any | undefined): value is Error {
  return error && ((error as Error).message !== undefined);
}

然后在

中使用

const errorMessage = isError(error.error) ? error.error.message : error.statusText;

Answer 2

你有两个选择，当你知道error 总是有一个特定的类型时，你可以只注解这个类型。如果不能确定，可以使用type guard。

类型注释

使用类型注释，您可以简单地告诉编译器，您期望error 是某种类型。您可以使用这种方法完全避免 any 类型：

interface Error {
    status: string,
    statusText: string,
    error: { message: string | undefined } | undefined;
}

catchError((error: Error | undefined) => {
    //...
}

类型保护

只要值可能属于某种类型，但不一定必须属于那种类型，您就可以使用类型保护。类型保护将检查类型，并在以下块中，变量将是检查的类型：

function isError(value: any | undefined): value is Error {
    return error && ((error as Error).status !== undefined);
}

catchError(error => {
    if (isError(error)) {
        //Inside this block, error will be of type Error
    }
}