webdriverio/webdriverio

[馃摉 Docs]: AsyncIterators

Open

#13,919 opened on Nov 25, 2024

View on GitHub
聽(2 comments)聽(0 reactions)聽(0 assignees)JavaScript聽(6,029 stars)聽(1,793 forks)batch import
Docs 馃摉help wanted

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

Tech stack
javascripttypescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with WebdriverIOJavaScript async iterators
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requests documentation for iterator functions like `map()` and `mapSeries()` from `ChainablePromiseArray` (`$$()`). The implementation is in `packages/wdio utils/src/pIteration.ts`. The contributor should extract the doc comments from that file and create a new documentation section in the WebdriverIO docs. Additionally, ensure the doc comments are added to the type definition files. The issue suggests looking at the existing API documentation structure to add a dedicated section for AsyncIterators.
[馃摉 Docs]: AsyncIterators 路 webdriverio/webdriverio#13919 | Good First Issue