Update waitForElementToBeRemoved docs #500
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To match the recent change to its return type (and TS typedef) Original issue: dom-testing-library issue testing-library#610
tjefferson08
commented
Jun 14, 2020
| @@ -63,24 +63,24 @@ function waitForElementToBeRemoved<T>( | |||
| interval?: number | |||
| mutationObserverOptions?: MutationObserverInit | |||
| } | |||
| ): Promise<T> | |||
| ): Promise<void> | |||
There was a problem hiding this comment.
Intended change here!
tjefferson08
commented
Jun 14, 2020
| ``` | ||
|
|
||
| To wait for the removal of element(s) from the DOM you can use | ||
| `waitForElementToBeRemoved`. The `waitForElementToBeRemoved` function is a small | ||
| wrapper around the `wait` utility. | ||
| wrapper around the `waitFor` utility. |
tjefferson08
commented
Jun 14, 2020
|
|
||
| Here is an example where the promise resolves with `true` because the element is | ||
| removed: | ||
| Here is an example where the promise resolves because the element is removed: |
There was a problem hiding this comment.
And here (that's it!)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To match the recent change to its return type (and TS typedef)
Original issue: dom-testing-library issue #610
A note for reviewers, it looks like the linting hooks have made some extra changes here, I'll throw a comment to highlight my intended (much smaller!) change