Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fix docs according to PR comments

Browse source
This commit is contained in:
Adam Gastineau 2025-01-23 12:13:26 -08:00
parent ee91e2e457
commit b0133a6142
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/src/api/class-pageassertions.md
View file

@ -323,9 +323,9 @@ expect(page).to_have_url(re.compile(".*checkout"))
await Expect(Page).ToHaveURLAsync(new Regex(".*checkout")); await Expect(Page).ToHaveURLAsync(new Regex(".*checkout"));
``` ```
### param: PageAssertions.toHaveURL.urlRegExOrPredicate ### param: PageAssertions.toHaveURL.url
* since: v1.18 * since: v1.18
- `urlRegExOrPredicate` <[string]|[RegExp]|[function]\([URL]\):[boolean]> - `url` <[string]|[RegExp]|[function]\([URL]\):[boolean]>
Expected URL string, RegExp, or predicate receiving [URL] to match. Expected URL string, RegExp, or predicate receiving [URL] to match.
When a [`option: Browser.newContext.baseURL`] via the context options was provided and the passed URL is a path, it gets merged via the [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor. When a [`option: Browser.newContext.baseURL`] via the context options was provided and the passed URL is a path, it gets merged via the [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
@ -334,7 +334,7 @@ When a [`option: Browser.newContext.baseURL`] via the context options was provid
* since: v1.44 * since: v1.44
- `ignoreCase` <[boolean]> - `ignoreCase` <[boolean]>
Whether to perform case-insensitive match. [`option: ignoreCase`] option takes precedence over the corresponding regular expression parameter if specified. The predicate parameter ignores this flag. Whether to perform case-insensitive match. [`option: ignoreCase`] option takes precedence over the corresponding regular expression parameter if specified. A provided predicate ignores this flag.
### option: PageAssertions.toHaveURL.timeout = %%-js-assertions-timeout-%% ### option: PageAssertions.toHaveURL.timeout = %%-js-assertions-timeout-%%
* since: v1.18 * since: v1.18

6
packages/playwright/types/test.d.ts vendored
View file

@ -8800,17 +8800,17 @@ interface PageAssertions {
* await expect(page).toHaveURL(/.*checkout/); * await expect(page).toHaveURL(/.*checkout/);
* ``` * ```
* *
* @param urlRegExOrPredicate Expected URL string, RegExp, or predicate receiving [URL] to match. When a * @param url Expected URL string, RegExp, or predicate receiving [URL] to match. When a
* [`baseURL`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-base-url) via the context * [`baseURL`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-base-url) via the context
* options was provided and the passed URL is a path, it gets merged via the * options was provided and the passed URL is a path, it gets merged via the
* [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor. * [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
* @param options * @param options
*/ */
toHaveURL(urlRegExOrPredicate: string|RegExp|((url: URL) => boolean), options?: { toHaveURL(url: string|RegExp|((url: URL) => boolean), options?: {
/** /**
* Whether to perform case-insensitive match. * Whether to perform case-insensitive match.
* [`ignoreCase`](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-url-option-ignore-case) * [`ignoreCase`](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-url-option-ignore-case)
* option takes precedence over the corresponding regular expression parameter if specified. The predicate parameter * option takes precedence over the corresponding regular expression parameter if specified. A provided predicate
* ignores this flag. * ignores this flag.
*/ */
ignoreCase?: boolean; ignoreCase?: boolean;