如何在 Typescript 中正确键入 React ErrorBoundary 类组件？

Question

这是我目前关于如何在 Typescript 中正确键入 React ErrorBoundary 类组件的尝试：

import React from "react";
import ErrorPage from "./ErrorPage";
import type { Store } from "redux";   // I'M PASSING THE REDUX STORE AS A CUSTOM PROP

interface Props {
  store: Store         // THIS IS A CUSTOM PROP THAT I'M PASSING
}

interface State {      // IS THIS THE CORRECT TYPE FOR THE state ?
  hasError: boolean
}

class ErrorBoundary extends React.Component<Props,State> {
  
  constructor(props: Props) {
    super(props);
    this.state = { hasError: false };
  }

  static getDerivedStateFromError(error): State {
    // Update state so the next render will show the fallback UI.
    return { hasError: true };
  }

  componentDidCatch(error, errorInfo: React.ErrorInfo): void {
    // You can also log the error to an error reporting service
    // logErrorToMyService(error, errorInfo);
    console.log("error: " + error);
    console.log("errorInfo: " + JSON.stringify(errorInfo));
    console.log("componentStack: " + errorInfo.componentStack);
  }

  render(): React.ReactNode {
    if (this.state.hasError) {
      // You can render any custom fallback UI
      return(
        <ErrorPage
          message={"Something went wrong..."}
        />
      );
    }

    return this.props.children;
  }
}

export default ErrorBoundary;

这个问题是关于这个ErrorBoundary 类组件的类型。我将它分成几部分以使其更容易。

---

A 部分：道具和状态的类型

我做的对吗？

interface Props {
  store: Store         // THIS IS A CUSTOM PROP THAT I'M PASSING
}

interface State {      // IS THIS THE CORRECT TYPE FOR THE state ?
  hasError: boolean
}

class ErrorBoundary extends React.Component<Props,State> {}

---

B 部分：getDerivedStateFromError(error)

error 参数应该选择什么类型？返回类型应该是State 类型吧？

static getDerivedStateFromError(error): State {
    // Update state so the next render will show the fallback UI.
    return { hasError: true };
  }

---

C部分：componentDidCatch(error, errorInfo: React.React.ErrorInfo)

error 参数应该选择什么类型？对于errorInfo，React 确实有一个似乎是正确的ErrorInfo 类型。是吗？返回类型应该是void，对吗？

componentDidCatch(error, errorInfo: React.ErrorInfo): void {
    console.log("error: " + error);
    console.log("errorInfo: " + JSON.stringify(errorInfo));
    console.log("componentStack: " + errorInfo.componentStack);
}

---

D 部分：render() 方法

返回类型应该是ReactNode 吗？

render(): React.ReactNode {
    if (this.state.hasError) {
      // You can render any custom fallback UI
      return(
        <ErrorPage
          message={"Something went wrong..."}
        />
      );
    }

    return this.props.children;
  }

Answer 1

您将在来自@types/react 的文件index.d.ts 中获得所有答案。如果您使用的是 VSCode 之类的 IDE，您可以 Ctrl+单击一个类型直接转到其定义。

这是您问题的准确答案，但在此之前，我建议您更喜欢使用 react hooks 而不是类。

---

由 OP 编辑​​：我从不使用类组件，总是更喜欢函数和钩子，但来自 React docs on Error Boundaries：

错误边界的工作方式类似于 JavaScript catch {} 块，但用于组件。 只有类组件可以是错误边界。

---

我给出的行是来自 index.d.ts 在版本 16.9.49 中的行。

A 部分：是的，就是这样。

B 部分：正如您在第 658 行看到的，error 的类型为 any，返回类型是 state 或 null 的一部分。

C 部分：在第 641 行，您将看到错误类型为 Error，返回类型为 void。

D 部分：在第 494 行，您可以看到渲染应该返回 ReactNode...

Answer 2

您可以使用以下代码作为错误边界：

import React, { Component, ErrorInfo, ReactNode } from "react";

interface Props {
  children: ReactNode;
}

interface State {
  hasError: boolean;
}

class ErrorBoundary extends Component<Props, State> {
  public state: State = {
    hasError: false
  };

  public static getDerivedStateFromError(_: Error): State {
    // Update state so the next render will show the fallback UI.
    return { hasError: true };
  }

  public componentDidCatch(error: Error, errorInfo: ErrorInfo) {
    console.error("Uncaught error:", error, errorInfo);
  }

  public render() {
    if (this.state.hasError) {
      return <h1>Sorry.. there was an error</h1>;
    }

    return this.props.children;
  }
}

export default ErrorBoundary;