Skip to content

fix(webdriverio): improve typing for execute and executeAsync#14465

Merged
christian-bromann merged 5 commits intomainfrom
cb/execute-typing
May 18, 2025
Merged

fix(webdriverio): improve typing for execute and executeAsync#14465
christian-bromann merged 5 commits intomainfrom
cb/execute-typing

Conversation

@christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented May 12, 2025

Proposed changes

When using execute or executeAsync a WebdriverIO.Element passed in as argument would be automatically transformed into a HTMLElement that it references by the WebDriver protocol. This wasn't reflected in the types.

This patch improves the typing around these 2 commands.

fixes #6486

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

n/a

Reviewers: @webdriverio/project-committers

@pkg-pr-new
Copy link

pkg-pr-new bot commented May 12, 2025 •
edited
Loading

Open in StackBlitz

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14465

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14465

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14465

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14465

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14465

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14465

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14465

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14465

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14465

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14465

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14465

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14465

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14465

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14465

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14465

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14465

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14465

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14465

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14465

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14465

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14465

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14465

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14465

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14465

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14465

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14465

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14465

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14465

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14465

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14465

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14465

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14465

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14465

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14465

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14465

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14465

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14465

commit: e2250c3

@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label May 18, 2025
@christian-bromann christian-bromann merged commit bc5a743 into main May 18, 2025
46 checks passed
@christian-bromann christian-bromann deleted the cb/execute-typing branch May 18, 2025 20:43
This was referenced Jun 3, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

PR: Bug Fix 🐛 PRs that contain bug fixes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Incorrect typing of browser.execute() (InnerArguments) for elements

1 participant

@christian-bromann