Documentation update for react$ and react$$ #3944
Conversation
Added 'selector' as the parameter in the documentation of react$. Please propose a better description for this parameter, if required.
|
|
|
@baruchvlz Please see if this is valid change. |
|
Can you please sign the CLA? |
Done! |
Codecov Report
@@ Coverage Diff @@
## master #3944 +/- ##
=======================================
Coverage 98.54% 98.54%
=======================================
Files 153 153
Lines 3448 3448
Branches 752 752
=======================================
Hits 3398 3398
Misses 45 45
Partials 5 5
Continue to review full report at Codecov.
|
|
Yea, saw this was missing as well. Thanks @Raulster24. |
Added parameter 'selector' for react$$ documentation
Raulster24
changed the title
| @@ -15,7 +15,8 @@ | |||
| }); | |||
| * </example> | |||
| * | |||
| * @alias browser.react$ | |||
| * @alias browser.react$$ | |||
| * @param {String=} selector React elements or HTML elements | |||
| * @param {Object=} props React props the element should contain | |||
| * @param {Object=} state React state the element should be in | |||
| * @return {Element} | |||
There was a problem hiding this comment.
does it return one Element, I suppose it should be Element[]
There was a problem hiding this comment.
@CrispusDH Yes, it should be Element[], it returns an array of elements. I will do the changes.
@baruchvlz Please confirm.
Co-Authored-By: Raulster24 <rahulsri.pccs@gmail.com>
Co-Authored-By: Raulster24 <rahulsri.pccs@gmail.com>
|
For some reason the typings display the return as |
If you use wdio testrunner in sync mode you need to import typings as follows: |
christian-bromann
added
the
PR: Docs 📝
* Documentation update for react$ Added 'selector' as the parameter in the documentation of react$. Please propose a better description for this parameter, if required. * removed trailing space * Documentation update for react$$ Added parameter 'selector' for react$$ documentation * Update description of parameter selector Co-Authored-By: Raulster24 <rahulsri.pccs@gmail.com> * Update description of parameter selector Co-Authored-By: Raulster24 <rahulsri.pccs@gmail.com> * Update to @return {Element} @return {Element} changed to @return {Element[]} as react$$ returns an array of elements * Update packages/webdriverio/src/commands/browser/react$.js Co-Authored-By: Raulster24 <rahulsri.pccs@gmail.com> * update @return {Element} update @return {Element} to @return {Element[]}
Proposed changes
Types of changes
Checklist
Further comments
Resolve #3943
Reviewers: @webdriverio/technical-committee