fix(TS): add timeout to MatcherOptions type #28
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
|
🎉 This PR is included in version 2.3.5 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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:
This change adds TypeScript support for the
timeoutmatcher option introduced in #7.Why:
Currently,
cypress-testing-libraryuses theMatcherOptionsinterface directly fromdom-testing-library, which does not have atimeoutproperty (timeoutis unique tocypress-testing-library), so using thetimeoutoption throws a type error.How:
I introduced a new
CTLMatcherOptionsinterface forcypress-testing-libraryspecific matcher options, aliased theMatcherOptionsimport fromdom-testing-librarytoDTLMatcherOptions, and created a new typeMatcherOptions, a union of the two. I also addedtimeoutto the existing typings test (which fails without this change).Checklist:
Additional Information:
The build was failing because the commands snapshot was outdated (new commands were added to
dom-testing-librarymore recently thancypress-testing-libraryhas been built on CI). I fixed the snapshot in this PR so I could progress, but let me know if you'd prefer that be separated out in its own PR and I'll split them up.