[#610] waitForElementToBeRemoved: fix return type #631
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
There's a couple options here, as issue testing-library#610 enumerates nicely. 1) Resolve to the type param T Keeping references to removed elements is a probable source of bugs and confusing tests. A reference should be easy enough to obtain with other test utilities; I submit that there's no added value in providing it here. 2) Resolve to boolean (or literal `true`) Not a bad choice by any means, but not particularly meaningful (the fulfillment of the promise is signal enough IMO) 3) Resolve to something empty This is what I've gone with. We are _literally_ waiting for removal, after all :) Fixes testing-library#610
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 6f3ea3d:
|
Codecov Report
@@ Coverage Diff @@
## master #631 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 24 24
Lines 565 565
Branches 141 141
=========================================
Hits 565 565
Continue to review full report at Codecov.
|
|
@all-contributors please add @tjefferson08 for code and tests |
|
I've put up a pull request to add @tjefferson08! 🎉 |
|
🎉 This PR is included in version 7.14.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
sandersn
added a commit
to DefinitelyTyped/DefinitelyTyped
that referenced
this pull request
Jun 29, 2020
waitForElementToBeRemoved had the wrong return type, and it got fixed in testing-library/dom-testing-library#631 This PR updates @testing-library/vue, which depends on @testing-library/dom.
sandersn
added a commit
to DefinitelyTyped/DefinitelyTyped
that referenced
this pull request
Jun 29, 2020
waitForElementToBeRemoved had the wrong return type, and it got fixed in testing-library/dom-testing-library#631 This PR updates @testing-library/vue, which depends on @testing-library/dom.
ngbrown
pushed a commit
to ngbrown-forks/DefinitelyTyped
that referenced
this pull request
Jul 11, 2020
waitForElementToBeRemoved had the wrong return type, and it got fixed in testing-library/dom-testing-library#631 This PR updates @testing-library/vue, which depends on @testing-library/dom.
danielrearden
pushed a commit
to danielrearden/DefinitelyTyped
that referenced
this pull request
Sep 22, 2020
waitForElementToBeRemoved had the wrong return type, and it got fixed in testing-library/dom-testing-library#631 This PR updates @testing-library/vue, which depends on @testing-library/dom.
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.
What:
A possible fix for issue #610 -> a refinement to the return value (and TS type) for
waitForElementToBeRemovedWhy:
There's a mismatch between implementation and type signature (and docs)
How:
I've updated the return type to
Promise<void>(and implemented by returning undefined)For more details, please refer to the commit message(s)!
Checklist:
docs site