webdriverio / webdriverio/webdriverio
[📖 Docs]: AsyncIterators
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 9.8k
- Forks
- 2.7k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 69
Description
Pre-check
- 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
- I agree to follow this project's Code of Conduct
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/wdio-utils/src/pIteration.ts, especially the implementation and documentation strings for the iterator functions provided by $$() (ChainablePromiseArray). Compare those comments with node_modules/webdriverio/build/types.d.ts and the WebdriverIO API documentation. Done means the map() and mapSeries() differences and related AsyncIterators are documented in a dedicated section and the relevant type definitions include the doc comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100