Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing docs for 'sync' option in mount methods (even if deprecated) #1680

Closed
luckylooke opened this issue Sep 7, 2020 · 2 comments
Closed

Comments

@luckylooke
Copy link
Contributor

Documentation Feedback

First of all I a m really glad of your work and sharing with community. ❤️

I have some test they affect each other, when they run one by one they works but together I have got errors as "TypeError: Cannot read property '$scopedSlots' of undefined", so I found solution by mounting with option "sync: false". I wanted to get know what that option exactly is, but did not found the answer in docs.

I came over this options several times already, some examples:
#1605 (comment)
logaretm/vee-validate#1996 (comment)
etc..

So it seems it is quite widely used, but not documented.

Some of comments mentioned that it is deprecated options... even if it is true, it should be documented as it really does fix issues, so it is working and therefore it should have some docs written. It can be heavily marked as "derprecated" if it is so. But at least I could make better decision whether look for other solutions or rely on this option.

Thank you 🙏

Affected documentation page: https://vue-test-utils.vuejs.org/api/options.html#mounting-options

@winniehell
Copy link
Contributor

winniehell commented Sep 7, 2020

@luckylooke The documentation has been removed because the sync option no longer has any effect in recent versions of vue-test-utils (#1137). Are you using the currently released version?

@lmiller1990
Copy link
Member

Sync mode was deprecated quite a long time ago and that's why it's removed from the docs. sync: false is effectively the default now.

I don't see any value in documenting something that is not only deprecated by removed from the code base entirely.

I don't really see any actionable item here, so I will close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants