ckerr

#48447: docs: clarify optional args in webFrame.executeJavaScript()

Merged
Created: Oct 3, 2025, 9:13:42 AM
Merged: Oct 4, 2025, 9:28:07 AM
4 comments
Target: main

Description of Change

Fix a small documentation bug for the optional arguments in webFrame.executeJavaScript() and webFrame.executeJavaScriptInIsolatedWorld(): the hasUserGesture argument can be omitted, even when a callback is provided:

-### `webFrame.executeJavaScript(code[, userGesture, callback])`
+### `webFrame.executeJavaScript(code[, userGesture][, callback])`

This PR brings the docs in line with the pre-existing, tested behavior. Our tests do this in several places: 1, 2, 3, 4.

All reviews welcomed! CC @deepak1556, who reviewed a similar recent PR #48361

Checklist

Release Notes

Notes: none.

Backports

37-x-y
Merged
PR Number
#48459
Merged At
Oct 4, 2025, 11:44:51 AM
Released In
v37.6.1
Release Date
Oct 7, 2025, 12:47:19 PM
38-x-y
Merged
PR Number
#48460
Merged At
Oct 4, 2025, 11:45:05 AM
Released In
v38.2.2
Release Date
Oct 7, 2025, 11:03:07 AM
39-x-y
Merged
PR Number
#48458
Merged At
Oct 4, 2025, 11:44:42 AM
Released In
v39.0.0-alpha.9
Release Date
Oct 6, 2025, 8:32:10 AM

Semver Impact

Major
Breaking changes
Minor
New features
Patch
Bug fixes
None
Docs, tests, etc.

Semantic Versioning helps users understand the impact of updates:

  • Major (X.y.z): Breaking changes that may require code modifications
  • Minor (x.Y.z): New features that maintain backward compatibility
  • Patch (x.y.Z): Bug fixes that don't change the API
  • None: Changes that don't affect using facing parts of Electron