webdriverio
webdriverio copied to clipboard
[📖 Docs]: AsyncIterators
Pre-check
- [X] I know I can edit the docs but prefer to file this issue
Describe the improvement
Missing documentation
Description of the improvement / report
I'm learning the API and stumbled upon the iterator functions provided by $$() (ChainablePromiseArray).
I wondered what the difference between map() and mapSeries() were, but did not find any usable information in the Documentation. Neither a search in the WebdriverIO API documentation nor the type definitions (node_modules/webdriverio/build/types.d.ts) held any information. I had to look at the implementation to find the documentation strings: https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-utils/src/pIteration.ts#L31
I suggest that there should be a dedicated Section about the AsyncIterators and that the doc comments are also added to the type definition files.
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Thanks for raising the issue @htho
Where would you suggest this documentation should be added? Would you be open making a contribution?
Thanks for reporting!
We greatly appreciate any contributions that help resolve the bug. While we understand that active contributors have their own priorities, we kindly request your assistance if you rely on this bug being fixed. We encourage you to take a look at our contribution guidelines or join our friendly Discord development server, where you can ask any questions you may have. Thank you for your support, and cheers!