fix(types): document inline options#41860
Closed
pavelfeldman wants to merge 1 commit into
Closed
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 35f115a2-a27a-4abf-9568-d6fbd5fd46e7
Contributor
Test results for "MCP"1 failed 7759 passed, 1249 skipped Merge workflow run. |
Contributor
Test results for "tests 1"7 flaky49956 passed, 1186 skipped Merge workflow run. |
Contributor
🟢 CI is clear — the one failure is a pre-existing flakeHi, I'm the Playwright bot and I took a look at the failing CI. The only failure is DetailsPre-existing flake / infra
Triaged by the Playwright bot - agent run |
yury-s
reviewed
Jul 17, 2026
| @@ -133,6 +133,11 @@ export interface Page { | |||
| * @param arg Optional argument to pass to | |||
| * [`pageFunction`](https://playwright.dev/docs/api/class-page#page-evaluate-option-expression). | |||
| * @param options | |||
| * @param options.exposeFunctions When set to `true`, functions passed inside | |||
Member
There was a problem hiding this comment.
can we instead document individual fields inline (same as e.g. goto does) ?
dgozman
reviewed
Jul 19, 2026
| * without any content or with `display:none` has an empty bounding box and is not considered visible. | ||
| * - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or | ||
| * `visibility:hidden`. This is opposite to the `'visible'` option. | ||
| * @param options.strict When true, the call requires selector to resolve to a single element. If given selector resolves to more than one |
Collaborator
There was a problem hiding this comment.
I think these options are already documented. Here is my VSCode knowing about them:
| @@ -969,6 +1119,12 @@ export interface Page { | |||
| * | |||
| * @param type | |||
| * @param options | |||
| * @param options.behavior Specifies whether to wait for already running listeners and what to do if they throw errors: | |||
Collaborator
There was a problem hiding this comment.
Same here - options.behavior is actually documented 10 lines below with the same comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@param options.<property>documentation from API docs