From f23d39abbf040b078e21ecc4327f1433b0157fc5 Mon Sep 17 00:00:00 2001 From: "microsoft-playwright-automation[bot]" <203992400+microsoft-playwright-automation[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 10:49:17 +0000 Subject: [PATCH] feat(roll): roll to ToT Playwright (08-07-26) --- dotnet/docs/api/class-elementhandle.mdx | 5 +- dotnet/docs/ci-intro.mdx | 2 +- dotnet/docs/ci.mdx | 6 +- java/docs/api/class-elementhandle.mdx | 5 +- java/docs/ci-intro.mdx | 2 +- java/docs/ci.mdx | 6 +- nodejs/docs/api/class-apirequestcontext.mdx | 21 ++++++ nodejs/docs/api/class-browsercontext.mdx | 2 +- nodejs/docs/api/class-elementhandle.mdx | 39 +++++----- nodejs/docs/api/class-filechooser.mdx | 2 +- nodejs/docs/api/class-frame.mdx | 62 +++++++-------- nodejs/docs/api/class-locator.mdx | 78 ++++++++++--------- nodejs/docs/api/class-locatorassertions.mdx | 84 +++++++++++++++++++++ nodejs/docs/api/class-page.mdx | 78 +++++++++---------- nodejs/docs/api/class-pageassertions.mdx | 12 +++ nodejs/docs/api/class-reporter.mdx | 32 ++++++++ nodejs/docs/api/class-route.mdx | 3 + nodejs/docs/api/class-suite.mdx | 74 ++++++++++++++++++ nodejs/docs/api/class-testcase.mdx | 74 ++++++++++++++++++ nodejs/docs/api/class-websocket.mdx | 2 +- nodejs/docs/api/class-worker.mdx | 2 +- nodejs/docs/ci-intro.mdx | 4 +- nodejs/docs/ci.mdx | 10 +-- nodejs/docs/test-sharding.mdx | 8 +- nodejs/docs/test-typescript.mdx | 2 +- python/docs/api/class-elementhandle.mdx | 5 +- python/docs/ci-intro.mdx | 2 +- python/docs/ci.mdx | 6 +- 28 files changed, 473 insertions(+), 155 deletions(-) diff --git a/dotnet/docs/api/class-elementhandle.mdx b/dotnet/docs/api/class-elementhandle.mdx index 8cc84ec85b..c2eecb5ed4 100644 --- a/dotnet/docs/api/class-elementhandle.mdx +++ b/dotnet/docs/api/class-elementhandle.mdx @@ -759,7 +759,10 @@ await ElementHandle.InputValueAsync(options); - `options` `ElementHandleInputValueOptions?` *(optional)* - `Timeout` [float]? *(optional)*# - Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. + :::warning[Deprecated] + This option is ignored. The value is returned immediately. + ::: + **Returns** - [string]# diff --git a/dotnet/docs/ci-intro.mdx b/dotnet/docs/ci-intro.mdx index f81a489f8f..341a04a7cb 100644 --- a/dotnet/docs/ci-intro.mdx +++ b/dotnet/docs/ci-intro.mdx @@ -31,7 +31,7 @@ jobs: timeout-minutes: 60 runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - name: Setup dotnet uses: actions/setup-dotnet@v5 with: diff --git a/dotnet/docs/ci.mdx b/dotnet/docs/ci.mdx index 70ae0ce978..9ee53130e2 100644 --- a/dotnet/docs/ci.mdx +++ b/dotnet/docs/ci.mdx @@ -47,7 +47,7 @@ jobs: timeout-minutes: 60 runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - name: Setup dotnet uses: actions/setup-dotnet@v5 with: @@ -79,7 +79,7 @@ jobs: image: mcr.microsoft.com/playwright/dotnet:v1.61.0-noble options: --user 1001 steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - name: Setup dotnet uses: actions/setup-dotnet@v5 with: @@ -103,7 +103,7 @@ jobs: runs-on: ubuntu-latest if: github.event.deployment_status.state == 'success' steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - name: Setup dotnet uses: actions/setup-dotnet@v5 with: diff --git a/java/docs/api/class-elementhandle.mdx b/java/docs/api/class-elementhandle.mdx index e293a262b4..2b4deca915 100644 --- a/java/docs/api/class-elementhandle.mdx +++ b/java/docs/api/class-elementhandle.mdx @@ -766,7 +766,10 @@ ElementHandle.inputValue(options); - `options` `ElementHandle.InputValueOptions` *(optional)* - `setTimeout` [double] *(optional)*# - Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. + :::warning[Deprecated] + This option is ignored. The value is returned immediately. + ::: + **Returns** - [String]# diff --git a/java/docs/ci-intro.mdx b/java/docs/ci-intro.mdx index 03ce5c94d9..dabb94d078 100644 --- a/java/docs/ci-intro.mdx +++ b/java/docs/ci-intro.mdx @@ -31,7 +31,7 @@ jobs: timeout-minutes: 60 runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-java@v5 with: distribution: 'temurin' diff --git a/java/docs/ci.mdx b/java/docs/ci.mdx index ed30ecfc63..c5349fb4cd 100644 --- a/java/docs/ci.mdx +++ b/java/docs/ci.mdx @@ -46,7 +46,7 @@ jobs: timeout-minutes: 60 runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-java@v5 with: distribution: 'temurin' @@ -78,7 +78,7 @@ jobs: image: mcr.microsoft.com/playwright/java:v1.61.0-noble options: --user 1001 steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-java@v5 with: distribution: 'temurin' @@ -103,7 +103,7 @@ jobs: runs-on: ubuntu-latest if: github.event.deployment_status.state == 'success' steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-java@v5 with: distribution: 'temurin' diff --git a/nodejs/docs/api/class-apirequestcontext.mdx b/nodejs/docs/api/class-apirequestcontext.mdx index 252d54c4e3..612e24a77a 100644 --- a/nodejs/docs/api/class-apirequestcontext.mdx +++ b/nodejs/docs/api/class-apirequestcontext.mdx @@ -80,6 +80,9 @@ await apiRequestContext.delete(url, options); - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -191,6 +194,9 @@ await request.fetch('https://example.com/api/uploadForm', { - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -272,6 +278,9 @@ await request.get('https://example.com/api/getText', { params: queryString }); - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -335,6 +344,9 @@ await apiRequestContext.head(url, options); - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -398,6 +410,9 @@ await apiRequestContext.patch(url, options); - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -492,6 +507,9 @@ await request.post('https://example.com/api/uploadForm', { - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. @@ -555,6 +573,9 @@ await apiRequestContext.put(url, options); - `params` [Object]<[string], [string] | [number] | [boolean]> | [URLSearchParams] | [string] *(optional)*# Query parameters to be sent with the URL. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. diff --git a/nodejs/docs/api/class-browsercontext.mdx b/nodejs/docs/api/class-browsercontext.mdx index 7f69c88185..2d570b5366 100644 --- a/nodejs/docs/api/class-browsercontext.mdx +++ b/nodejs/docs/api/class-browsercontext.mdx @@ -1058,7 +1058,7 @@ const page = await pagePromise; - `predicate` [function] *(optional)*# Receives the event data and resolves to truthy value when the waiting should resolve. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the waiting using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the waiting will be aborted and the operation will throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. diff --git a/nodejs/docs/api/class-elementhandle.mdx b/nodejs/docs/api/class-elementhandle.mdx index b384e3b67a..e945b96fad 100644 --- a/nodejs/docs/api/class-elementhandle.mdx +++ b/nodejs/docs/api/class-elementhandle.mdx @@ -147,7 +147,7 @@ await elementHandle.waitForElementState(state, options); A state to wait for, see below for more details. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -362,7 +362,7 @@ await elementHandle.check(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -441,7 +441,7 @@ await elementHandle.click(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `steps` [number] *(optional)* Added in: v1.57# @@ -524,7 +524,7 @@ await elementHandle.dblclick(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `steps` [number] *(optional)* Added in: v1.57# @@ -636,7 +636,7 @@ await elementHandle.fill(value, options); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -755,7 +755,7 @@ await elementHandle.hover(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -844,7 +844,10 @@ await elementHandle.inputValue(options); - `options` [Object] *(optional)* - `timeout` [number] *(optional)*# - Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. + :::warning[Deprecated] + This option is ignored. The value is returned immediately. + ::: + **Returns** - [Promise]<[string]># @@ -1043,7 +1046,7 @@ await elementHandle.press(key, options); Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1111,7 +1114,7 @@ await elementHandle.screenshot(options); When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger. Defaults to `"device"`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `style` [string] *(optional)* Added in: v1.41# @@ -1155,7 +1158,7 @@ await elementHandle.scrollIntoViewIfNeeded(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1224,7 +1227,7 @@ handle.selectOption(['red', 'green', 'blue']); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1263,7 +1266,7 @@ await elementHandle.selectText(options); - `force` [boolean] *(optional)* Added in: v1.13# Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1330,7 +1333,7 @@ await elementHandle.setChecked(checked, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1387,7 +1390,7 @@ await elementHandle.setInputFiles(files, options); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1458,7 +1461,7 @@ await elementHandle.tap(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1530,7 +1533,7 @@ To press a special key, like `Control` or `ArrowDown`, use [elementHandle.press( This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1595,7 +1598,7 @@ await elementHandle.uncheck(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1643,7 +1646,7 @@ This method does not work across navigations, use [page.waitForSelector()](/api/ A selector to query for. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `state` "attached" | "detached" | "visible" | "hidden" *(optional)*# diff --git a/nodejs/docs/api/class-filechooser.mdx b/nodejs/docs/api/class-filechooser.mdx index 2e9b451084..e4fd49668f 100644 --- a/nodejs/docs/api/class-filechooser.mdx +++ b/nodejs/docs/api/class-filechooser.mdx @@ -106,7 +106,7 @@ await fileChooser.setFiles(files, options); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# diff --git a/nodejs/docs/api/class-frame.mdx b/nodejs/docs/api/class-frame.mdx index b058890c11..8776ca0e77 100644 --- a/nodejs/docs/api/class-frame.mdx +++ b/nodejs/docs/api/class-frame.mdx @@ -171,7 +171,7 @@ await frame.dragAndDrop(source, target, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `sourcePosition` [Object] *(optional)* Added in: v1.14# @@ -731,7 +731,7 @@ await frame.goto(url, options); - `referer` [string] *(optional)*# Referer header value. If provided it will take preference over the referer header value set by [page.setExtraHTTPHeaders()](/api/class-page.mdx#page-set-extra-http-headers). - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -785,7 +785,7 @@ await frame.isEnabled(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -922,7 +922,7 @@ await frame.setContent(html, options); HTML markup to assign to the page. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1016,7 +1016,7 @@ await frame.waitForFunction(selector => !!document.querySelector(selector), sele - `polling` [number] | "raf" *(optional)*# If [polling](/api/class-frame.mdx#frame-wait-for-function-option-polling) is `'raf'`, then [pageFunction](/api/class-frame.mdx#frame-wait-for-function-option-expression) is constantly executed in `requestAnimationFrame` callback. If [polling](/api/class-frame.mdx#frame-wait-for-function-option-polling) is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to `raf`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1056,7 +1056,7 @@ await frame.waitForLoadState(); // Waits for 'load' state by default. * `'domcontentloaded'` - wait for the `DOMContentLoaded` event to be fired. * `'networkidle'` - **DISCOURAGED** wait until there are no network connections for at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the waiting using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the waiting will be aborted and the operation will throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1086,7 +1086,7 @@ await frame.waitForURL('**/target.html'); A glob pattern, regex pattern, URL pattern, or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the waiting using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the waiting will be aborted and the operation will throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1323,7 +1323,7 @@ await frame.check(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1407,7 +1407,7 @@ await frame.click(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1492,7 +1492,7 @@ await frame.dblclick(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1562,7 +1562,7 @@ await frame.dispatchEvent('#source', 'dragstart', { dataTransfer }); Optional event-specific initialization properties. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1620,7 +1620,7 @@ await frame.fill(selector, value, options); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1660,7 +1660,7 @@ await frame.focus(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1703,7 +1703,7 @@ await frame.getAttribute(selector, name, options); Attribute name to get the value for. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1774,7 +1774,7 @@ await frame.hover(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1817,7 +1817,7 @@ await frame.innerHTML(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1857,7 +1857,7 @@ await frame.innerText(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1899,7 +1899,7 @@ await frame.inputValue(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1939,7 +1939,7 @@ await frame.isChecked(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -1979,7 +1979,7 @@ await frame.isDisabled(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2019,7 +2019,7 @@ await frame.isEditable(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2163,7 +2163,7 @@ await frame.press(selector, key, options); Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2238,7 +2238,7 @@ frame.selectOption('select#colors', 'red', 'green', 'blue'); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2312,7 +2312,7 @@ await frame.setChecked(selector, checked, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)*# @@ -2375,7 +2375,7 @@ await frame.setInputFiles(selector, files, options); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2451,7 +2451,7 @@ await frame.tap(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2494,7 +2494,7 @@ await frame.textContent(selector, options); A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2545,7 +2545,7 @@ To press a special key, like `Control` or `ArrowDown`, use [keyboard.press()](/a This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2615,7 +2615,7 @@ await frame.uncheck(selector, options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2663,7 +2663,7 @@ Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/Hist **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the waiting using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the waiting will be aborted and the operation will throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2729,7 +2729,7 @@ const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'. A selector to query for. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `state` "attached" | "detached" | "visible" | "hidden" *(optional)*# diff --git a/nodejs/docs/api/class-locator.mdx b/nodejs/docs/api/class-locator.mdx index 2bb081709d..b48d768acf 100644 --- a/nodejs/docs/api/class-locator.mdx +++ b/nodejs/docs/api/class-locator.mdx @@ -134,7 +134,7 @@ await page.getByRole('link').ariaSnapshot(); - `mode` "ai" | "default" *(optional)* Added in: v1.59# When set to `"ai"`, returns a snapshot optimized for AI consumption. Defaults to `"default"`. See details for more information. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -190,7 +190,7 @@ await locator.blur(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -217,7 +217,7 @@ await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -285,7 +285,7 @@ await page.getByRole('checkbox').check(); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -338,7 +338,7 @@ await page.getByRole('textbox').clear(); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -416,7 +416,7 @@ await page.locator('canvas').click({ - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `steps` [number] *(optional)* Added in: v1.57# @@ -538,7 +538,7 @@ await locator.dblclick(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `steps` [number] *(optional)* Added in: v1.57# @@ -636,7 +636,7 @@ await locator.dispatchEvent('click'); Optional event-specific initialization properties. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -712,7 +712,7 @@ await source.dragTo(target, { - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `sourcePosition` [Object] *(optional)*# @@ -804,7 +804,7 @@ await page.locator('#dropzone').drop({ A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -847,6 +847,9 @@ console.log(result); // prints "myId text 56" Optional argument to pass to [pageFunction](/api/class-locator.mdx#locator-evaluate-option-expression). - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to `0` - no timeout. @@ -919,6 +922,9 @@ await locator.evaluateHandle(pageFunction, arg, options); Optional argument to pass to [pageFunction](/api/class-locator.mdx#locator-evaluate-handle-option-expression). - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved, evaluation itself is not limited by the timeout. Defaults to `0` - no timeout. @@ -968,7 +974,7 @@ await page.getByRole('textbox').fill('example value'); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1066,7 +1072,7 @@ await locator.focus(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1124,7 +1130,7 @@ await locator.getAttribute(name, options); Attribute name to get the value for. - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1562,7 +1568,7 @@ await page.getByRole('link').hover(); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1603,7 +1609,7 @@ await locator.innerHTML(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1635,7 +1641,7 @@ await locator.innerText(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1666,7 +1672,7 @@ const value = await page.getByRole('textbox').inputValue(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1701,7 +1707,7 @@ const checked = await page.getByRole('checkbox').isChecked(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1732,7 +1738,7 @@ const disabled = await page.getByRole('button').isDisabled(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1763,7 +1769,7 @@ const editable = await page.getByRole('textbox').isEditable(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -1794,7 +1800,7 @@ const enabled = await page.getByRole('button').isEnabled(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2047,7 +2053,7 @@ await page.getByRole('textbox').press('Backspace'); Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2119,7 +2125,7 @@ await locator.press('Enter'); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2181,7 +2187,7 @@ await page.getByRole('link').screenshot({ animations: 'disabled', path: 'link.pn When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger. Defaults to `"device"`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `style` [string] *(optional)* Added in: v1.41# @@ -2224,7 +2230,7 @@ await locator.scrollIntoViewIfNeeded(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2288,7 +2294,7 @@ element.selectOption(['red', 'green', 'blue']); This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2330,7 +2336,7 @@ await locator.selectText(options); - `force` [boolean] *(optional)*# Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2381,7 +2387,7 @@ await page.getByRole('checkbox').setChecked(true); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2460,7 +2466,7 @@ await page.getByLabel('Upload file').setInputFiles({ This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2518,7 +2524,7 @@ await locator.tap(options); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2569,7 +2575,7 @@ await locator.textContent(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2634,7 +2640,7 @@ await page.getByRole('checkbox').uncheck(); - `scroll` "auto" | "none" *(optional)* Added in: v1.62# Controls whether Playwright scrolls the element into view before performing the action. Defaults to `"auto"`, which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to `"none"`, Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2679,7 +2685,7 @@ await orderSent.waitFor(); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `state` "attached" | "detached" | "visible" | "hidden" *(optional)*# @@ -2736,7 +2742,7 @@ await page.getByTestId('status').waitForFunction((element, value) => { Optional argument to pass to [pageFunction](/api/class-locator.mdx#locator-wait-for-function-option-expression). - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)*# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2772,7 +2778,7 @@ await locator.elementHandle(options); **Arguments** - `options` [Object] *(optional)* - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# @@ -2841,7 +2847,7 @@ To press a special key, like `Control` or `ArrowDown`, use [locator.press()](/ap This option has no effect. - - `signal` [AbortSignal] *(optional)* Added in: v1.61# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# Allows to cancel the operation using an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal). If the signal is aborted, the operation will be aborted and throw an error. Note that providing a signal does not disable the default timeout, which can be changed using [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout); pass `timeout: 0` to disable the timeout entirely. - `timeout` [number] *(optional)*# diff --git a/nodejs/docs/api/class-locatorassertions.mdx b/nodejs/docs/api/class-locatorassertions.mdx index 1b11e9faa0..be92a9649a 100644 --- a/nodejs/docs/api/class-locatorassertions.mdx +++ b/nodejs/docs/api/class-locatorassertions.mdx @@ -39,6 +39,9 @@ await expect(page.getByText('Hidden text')).toBeAttached(); **Arguments** - `options` [Object] *(optional)* - `attached` [boolean] *(optional)*# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -69,6 +72,9 @@ await expect(locator).toBeChecked(); - `indeterminate` [boolean] *(optional)* Added in: v1.50# Asserts that the element is in the indeterminate (mixed) state. Only supported for checkboxes and radio buttons. This option can't be true when [checked](/api/class-locatorassertions.mdx#locator-assertions-to-be-checked-option-checked) is provided. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -93,6 +99,9 @@ await expect(locator).toBeDisabled(); **Arguments** - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -118,6 +127,9 @@ await expect(locator).toBeEditable(); **Arguments** - `options` [Object] *(optional)* - `editable` [boolean] *(optional)* Added in: v1.26# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -142,6 +154,9 @@ await expect(locator).toBeEmpty(); **Arguments** - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -167,6 +182,9 @@ await expect(locator).toBeEnabled(); **Arguments** - `options` [Object] *(optional)* - `enabled` [boolean] *(optional)* Added in: v1.26# + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -191,6 +209,9 @@ await expect(locator).toBeFocused(); **Arguments** - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -215,6 +236,9 @@ await expect(locator).toBeHidden(); **Arguments** - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -247,6 +271,9 @@ await expect(locator).toBeInViewport({ ratio: 0.5 }); - `ratio` [number] *(optional)*# The minimal ratio of the element to intersect viewport. If equals to `0`, then element should intersect viewport at any positive ratio. Defaults to `0`. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -283,6 +310,9 @@ await expect( **Arguments** - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -332,6 +362,9 @@ await expect(locator).toContainClass(['inactive', 'active', 'inactive']); A string containing expected class names, separated by spaces, or a list of such strings to assert multiple elements. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -395,6 +428,9 @@ await expect(page.locator('ul')).toContainText(['Text 3']); - `ignoreCase` [boolean] *(optional)* Added in: v1.23# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-contain-text-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -432,6 +468,9 @@ await expect(locator).toHaveAccessibleDescription('Save results to disk'); - `ignoreCase` [boolean] *(optional)*# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-have-accessible-description-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -462,6 +501,9 @@ await expect(locator).toHaveAccessibleErrorMessage('Username is required.'); - `ignoreCase` [boolean] *(optional)*# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-have-accessible-error-message-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -492,6 +534,9 @@ await expect(locator).toHaveAccessibleName('Save to disk'); - `ignoreCase` [boolean] *(optional)*# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-have-accessible-name-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -525,6 +570,9 @@ await expect(locator).toHaveAttribute('type', 'text'); - `ignoreCase` [boolean] *(optional)* Added in: v1.40# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-have-attribute-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -559,6 +607,9 @@ await expect(locator).toHaveAttribute(name, options); Attribute name. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -598,6 +649,9 @@ await expect(locator).toHaveClass(['component', 'component selected', 'component Expected class or RegExp or a list of those. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -625,6 +679,9 @@ await expect(list).toHaveCount(3); Expected count. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -658,6 +715,9 @@ await expect(locator).toHaveCSS('display', 'flex'); - `pseudo` "before" | "after" *(optional)* Added in: v1.60# Pseudo-element to read computed styles from. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -685,6 +745,9 @@ await expect(locator).toHaveId('lastname'); Element id. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -715,6 +778,9 @@ await expect(locator).toHaveJSProperty('loaded', true); Property value. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -744,6 +810,9 @@ await expect(locator).toHaveRole('button'); Required aria role. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -933,6 +1002,9 @@ await expect(page.locator('ul')).toHaveText(['Text 1', 'Text 2', 'Text 3']); - `ignoreCase` [boolean] *(optional)* Added in: v1.23# Whether to perform case-insensitive match. [ignoreCase](/api/class-locatorassertions.mdx#locator-assertions-to-have-text-option-ignore-case) option takes precedence over the corresponding regular expression flag if specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -967,6 +1039,9 @@ await expect(locator).toHaveValue(/[0-9]/); Expected value. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)* Added in: v1.18# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -1005,6 +1080,9 @@ await expect(locator).toHaveValues([/R/, /G/]); Expected options currently selected. - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -1033,6 +1111,9 @@ await expect(page.locator('body')).toMatchAriaSnapshot(` **Arguments** - `expected` [string]# - `options` [Object] *(optional)* + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. @@ -1062,6 +1143,9 @@ await expect(page.locator('body')).toMatchAriaSnapshot({ name: 'body.aria.yml' } - `name` [string] *(optional)*# Name of the snapshot to store in the snapshot folder corresponding to this test. Generates sequential names if not specified. + - `signal` [AbortSignal] *(optional)* Added in: v1.62# + + An optional [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that can cancel the assertion. Aborting the signal fails the assertion like a timeout: if the signal is aborted while the assertion is retrying, or is already aborted before the assertion starts, the assertion fails without retrying further. - `timeout` [number] *(optional)*# Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`. diff --git a/nodejs/docs/api/class-page.mdx b/nodejs/docs/api/class-page.mdx index 61c004a586..00aa7a4523 100644 --- a/nodejs/docs/api/class-page.mdx +++ b/nodejs/docs/api/class-page.mdx @@ -281,7 +281,7 @@ await page.ariaSnapshot(options); - `mode` "ai" | "default" *(optional)*# When set to `"ai"`, returns a snapshot optimized for AI consumption: including element references like `[ref=e2]` and snapshots of `