Skip to content

Commit

Permalink
docs: provide example for componentDidMount (#144)
Browse files Browse the repository at this point in the history
### Summary
Some people find it useful to search for specific terms when browsing the docs.
Specifying the concrete utility of the `update` method makes the doc more useful :)
  • Loading branch information
jmporchet authored and thymikee committed Apr 1, 2019
1 parent b4cfb95 commit 859e29c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/API.md
Expand Up @@ -98,7 +98,9 @@ A method returning an array of `ReactTestInstance`s with matching a React compon
### `update: (element: React.Element<any>) => void`

Re-render the in-memory tree with a new root element. This simulates a React update at the root. If the new element has the same type and key as the previous element, the tree will be updated; otherwise, it will re-mount a new tree.
Re-render the in-memory tree with a new root element. This simulates a React update at the root. If the new element has the same type and key as the previous element, the tree will be updated; otherwise, it will re-mount a new tree. This is useful when testing for `componentDidUpdate` behavior, by passing updated props to the component.

[Example code](https://github.com/callstack/react-native-testing-library/blob/f96d782d26dd4815dbfd01de6ef7a647efd1f693/src/__tests__/act.test.js#L31-L37)

### `unmount: () => void`

Expand Down

0 comments on commit 859e29c

Please sign in to comment.