[Docs] update simulateError with getDerivedStateFromError

enzymejs · Mar 11, 2019 · dfd1289 · dfd1289
1 parent e76ea4f
commit dfd1289
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 4 deletions.
diff --git a/docs/api/ReactWrapper/simulateError.md b/docs/api/ReactWrapper/simulateError.md
@@ -2,7 +2,7 @@
 
 Simulate a component throwing an error as part of its rendering lifecycle.
 
-This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` lifecycle method).
+This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` and `static getDerivedStateFromError` lifecycle methods).
 
 
 #### Arguments
@@ -26,16 +26,28 @@ function Something() {
 }
 
 class ErrorBoundary extends React.Component {
+  static getDerivedStateFromError(error) {
+    return {
+      hasError: true,
+    };
+  }
+
+  constructor(props) {
+    super(props);
+    this.state = { hasError: false };
+  }
+
   componentDidCatch(error, info) {
     const { spy } = this.props;
     spy(error, info);
   }
 
   render() {
     const { children } = this.props;
+    const { hasError } = this.state;
     return (
       <React.Fragment>
-        {children}
+        {hasError ? 'Error' : children}
       </React.Fragment>
     );
   }
@@ -50,6 +62,7 @@ const wrapper = mount(<ErrorBoundary spy={spy}><Something /></ErrorBoundary>);
 const error = new Error('hi!');
 wrapper.find(Something).simulateError(error);
 
+expect(wrapper.state()).to.have.property('hasError', true);
 expect(spy).to.have.property('callCount', 1);
 expect(spy.args).to.deep.equal([
   error,

diff --git a/docs/api/ShallowWrapper/simulateError.md b/docs/api/ShallowWrapper/simulateError.md
@@ -2,7 +2,7 @@
 
 Simulate a component throwing an error as part of its rendering lifecycle.
 
-This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` lifecycle method).
+This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` and `static getDerivedStateFromError` lifecycle methods).
 
 
 #### Arguments
@@ -26,16 +26,28 @@ function Something() {
 }
 
 class ErrorBoundary extends React.Component {
+  static getDerivedStateFromError(error) {
+    return {
+      hasError: true,
+    };
+  }
+
+  constructor(props) {
+    super(props);
+    this.state = { hasError: false };
+  }
+
   componentDidCatch(error, info) {
     const { spy } = this.props;
     spy(error, info);
   }
 
   render() {
     const { children } = this.props;
+    const { hasError } = this.state;
     return (
       <React.Fragment>
-        {children}
+        {hasError ? 'Error' : children}
       </React.Fragment>
     );
   }
@@ -50,6 +62,7 @@ const wrapper = shallow(<ErrorBoundary spy={spy}><Something /></ErrorBoundary>);
 const error = new Error('hi!');
 wrapper.find(Something).simulateError(error);
 
+expect(wrapper.state()).to.have.property('hasError', true);
 expect(spy).to.have.property('callCount', 1);
 expect(spy.args).to.deep.equal([
   error,