feat: include component and wrapper in return type for vue mount adapter #24479
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
|
Thanks for taking the time to open a PR!
|
ZachJW34
approved these changes
Nov 1, 2022
…ue-24342-update-vue-wrapper-return-type
|
Webkit system tests 🤷♂️ Everything else looks 💯 |
marktnoonan
approved these changes
Nov 2, 2022
ZachJW34
deleted the
lmiller/issue-24342-update-vue-wrapper-return-type
branch
Comment on lines
430
to
431
| // by returning undefined we keep the previous subject | ||
| // which is the mounted component |
There was a problem hiding this comment.
Comment no longer applicable
Comment on lines
+132
to
+135
| ): Cypress.Chainable<{ | ||
| wrapper: VueWrapper<ComponentPublicInstance<V>> | ||
| component: VueWrapper<ComponentPublicInstance<V>>['vm'] | ||
| }> |
There was a problem hiding this comment.
Still working on my Typescript, but would it make sense to introduce a generic return type like:
type MountReturn<C> = {
wrapper: VueWrapper<C>
component: C
}
to use for the return of all the mount overloads?
Result
export function mount<V extends {}>(
originalComponent: {
new (...args: any[]): V
__vccOpts: any
},
options?: MountingOptions<any> & Record<string, any>
): Cypress.Chainable<MountReturn<V>>
Would that work for all the overload cases?
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.
User facing changelog
Vue Mount adapter now returns an object with both the
VueWrapper(wrapper) and component instance (component).Additional details
Part of CT GA.
Steps to test
You could do
const foo = cy.mount(SomeVueComponent)then observe bothwrapperandcomponentproperties are available on the returned value.wrappercontains all of these methods from Vue Test Utils. Component contains various Vue related things.How has the user experience changed?
You can access the component instance, which is more in line with what other mount adapters do.
PR Tasks
cypress-documentation? NOT YETtype definitions?