From 913f85249fe280b58c06de873c9ea1cbe6808465 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Wed, 6 Jan 2021 20:02:51 -0800 Subject: [PATCH] docs: make all links relative (#4926) --- docs/src/actionability.md | 40 +- docs/src/debug.md | 2 +- docs/src/multi-pages.md | 2 +- docs/src/verification.md | 2 +- docs/src/why-playwright.md | 4 +- types/types.d.ts | 954 +++++++++++++++------------------ utils/doclint/Documentation.js | 24 - utils/generate_types/index.js | 2 +- 8 files changed, 451 insertions(+), 579 deletions(-) diff --git a/docs/src/actionability.md b/docs/src/actionability.md index f1e9771ccd..ca3ef24405 100644 --- a/docs/src/actionability.md +++ b/docs/src/actionability.md @@ -11,26 +11,26 @@ Some actions like [`method: Page.click`] support `force` option that disables no | Action | [Attached] | [Visible] | [Stable] | [Receiving Events] | [Enabled] | [Editable] | | :- | :-: | :-: | :-: | :-: | :-: | :-: | -| [`method: ElementHandle.check`] | Yes | Yes | Yes | Yes | Yes | - | -| [`method: ElementHandle.click`] | Yes | Yes | Yes | Yes | Yes | - | -| [`method: ElementHandle.dblclick`] | Yes | Yes | Yes | Yes | Yes | - | -| [`method: ElementHandle.tap`] | Yes | Yes | Yes | Yes | Yes | - | -| [`method: ElementHandle.uncheck`] | Yes | Yes | Yes | Yes | Yes | - | -| [`method: ElementHandle.hover`] | Yes | Yes | Yes | Yes | - | - | -| [`method: ElementHandle.scrollIntoViewIfNeeded`] | Yes | Yes | Yes | - | - | - | -| [`method: ElementHandle.screenshot`] | Yes | Yes | Yes | - | - | - | -| [`method: ElementHandle.fill`] | Yes | Yes | - | - | Yes | Yes | -| [`method: ElementHandle.selectText`] | Yes | Yes | - | - | - | - | -| [`method: ElementHandle.getAttribute`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.dispatchEvent`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.focus`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.innerText`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.innerHTML`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.press`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.setInputFiles`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.selectOption`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.textContent`] | Yes | - | - | - | - | - | -| [`method: ElementHandle.type`] | Yes | - | - | - | - | - | +| check | Yes | Yes | Yes | Yes | Yes | - | +| click | Yes | Yes | Yes | Yes | Yes | - | +| dblclick | Yes | Yes | Yes | Yes | Yes | - | +| tap | Yes | Yes | Yes | Yes | Yes | - | +| uncheck | Yes | Yes | Yes | Yes | Yes | - | +| hover | Yes | Yes | Yes | Yes | - | - | +| scrollIntoViewIfNeeded | Yes | Yes | Yes | - | - | - | +| screenshot | Yes | Yes | Yes | - | - | - | +| fill | Yes | Yes | - | - | Yes | Yes | +| selectText | Yes | Yes | - | - | - | - | +| dispatchEvent | Yes | - | - | - | - | - | +| focus | Yes | - | - | - | - | - | +| getAttribute | Yes | - | - | - | - | - | +| innerText | Yes | - | - | - | - | - | +| innerHTML | Yes | - | - | - | - | - | +| press | Yes | - | - | - | - | - | +| setInputFiles | Yes | - | - | - | - | - | +| selectOption | Yes | - | - | - | - | - | +| textContent | Yes | - | - | - | - | - | +| type | Yes | - | - | - | - | - |
diff --git a/docs/src/debug.md b/docs/src/debug.md index 4987d571f5..4a7ff06972 100644 --- a/docs/src/debug.md +++ b/docs/src/debug.md @@ -109,7 +109,7 @@ composite selectors. To use this: ### Evaluate Source Maps -PWDEBUG also enables source maps for [`page.evaluate` executions](core-concepts.md#evaluation). +PWDEBUG also enables source maps for [`page.evaluate` executions](./core-concepts.md#evaluation). This improves the debugging experience for JavaScript executions in the page context. Highlight selectors diff --git a/docs/src/multi-pages.md b/docs/src/multi-pages.md index b6375e7bb0..ac4347dba2 100644 --- a/docs/src/multi-pages.md +++ b/docs/src/multi-pages.md @@ -10,7 +10,7 @@ tabs in a browser window. ## Multiple contexts -[Browser contexts](core-concepts.md#browser-contexts) are isolated environments +[Browser contexts](./core-concepts.md#browser-contexts) are isolated environments on a single browser instance. Playwright can create multiple browser contexts within a single scenario. This is useful when you want to test for multi-user functionality, like chat. diff --git a/docs/src/verification.md b/docs/src/verification.md index 247a1ab56b..ac1a2f0490 100644 --- a/docs/src/verification.md +++ b/docs/src/verification.md @@ -7,7 +7,7 @@ title: "Verification" ## Videos -Playwright can record videos for all pages in a [browser context](core-concepts.md#browser-contexts). Videos are saved upon context closure, so make sure to await [`method: BrowserContext.close`]. +Playwright can record videos for all pages in a [browser context](./core-concepts.md#browser-contexts). Videos are saved upon context closure, so make sure to await [`method: BrowserContext.close`]. ```js // With browser.newContext() diff --git a/docs/src/why-playwright.md b/docs/src/why-playwright.md index 8748e18aa5..296a8d224d 100644 --- a/docs/src/why-playwright.md +++ b/docs/src/why-playwright.md @@ -21,12 +21,12 @@ Playwright enables fast, reliable and capable automation across all modern brows * **Timeout-free automation**. Playwright receives browser signals, like network requests, page navigations and page load events to eliminate the need for sleep timeouts that cause flakiness. -* **Lean parallelization with browser contexts**. Reuse a single browser instance for multiple parallelized, isolated execution environments with [browser contexts](core-concepts.md). +* **Lean parallelization with browser contexts**. Reuse a single browser instance for multiple parallelized, isolated execution environments with [browser contexts](./core-concepts.md). * **Resilient element selectors**. Playwright can rely on user-facing strings, like text content and accessibility labels to [select elements](./selectors.md). These strings are more resilient than selectors tightly-coupled to the DOM structure. ## Powerful automation capabilities -* **Multiple domains, pages and frames**. Playwright is an out-of-process automation driver that is not limited by the scope of in-page JavaScript execution and can automate scenarios with [multiple pages](multi-pages.md). +* **Multiple domains, pages and frames**. Playwright is an out-of-process automation driver that is not limited by the scope of in-page JavaScript execution and can automate scenarios with [multiple pages](./multi-pages.md). * **Powerful network control**. Playwright introduces context-wide [network interception](./network.md) to stub and mock network requests. diff --git a/types/types.d.ts b/types/types.d.ts index 9be4179c1e..2338950721 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -108,7 +108,7 @@ export interface Page { * ``` * * Shortcut for main frame's - * [frame.evaluate(pageFunction[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameevaluatepagefunction-arg). + * [frame.evaluate(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameevaluate). * @param pageFunction Function to be evaluated in the page context * @param arg Optional argument to pass to `pageFunction` */ @@ -149,8 +149,7 @@ export interface Page { * The method finds an element matching the specified selector within the page. If no elements match the selector, the * return value resolves to `null`. * - * Shortcut for main frame's - * [frame.$(selector)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameselector). + * Shortcut for main frame's [frame.$(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frame). * @param selector A selector to query for. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. */ $(selector: K): Promise | null>; @@ -160,8 +159,7 @@ export interface Page { * The method finds all elements matching the specified selector within the page. If no elements match the selector, the * return value resolves to `[]`. * - * Shortcut for main frame's - * [frame.$$(selector)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameselector). + * Shortcut for main frame's [frame.$$(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frame). * @param selector A selector to query for. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. */ $$(selector: K): Promise[]>; @@ -172,8 +170,8 @@ export interface Page { * `pageFunction`. If no elements match the selector, the method throws an error. Returns the value of `pageFunction`. * * If `pageFunction` returns a [Promise], then - * [page.$eval(selector, pageFunction[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageevalselector-pagefunction-arg) - * would wait for the promise to resolve and return its value. + * [page.$eval(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageeval) would wait for the promise to + * resolve and return its value. * * Examples: * @@ -183,8 +181,7 @@ export interface Page { * const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello'); * ``` * - * Shortcut for main frame's - * [frame.$eval(selector, pageFunction[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameevalselector-pagefunction-arg). + * Shortcut for main frame's [frame.$eval(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameeval). * @param selector A selector to query for. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. * @param pageFunction Function to be evaluated in browser context * @param arg Optional argument to pass to `pageFunction` @@ -199,8 +196,8 @@ export interface Page { * a first argument to `pageFunction`. Returns the result of `pageFunction` invocation. * * If `pageFunction` returns a [Promise], then - * [page.$$eval(selector, pageFunction[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageevalselector-pagefunction-arg) - * would wait for the promise to resolve and return its value. + * [page.$$eval(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageeval) would wait for the promise to + * resolve and return its value. * * Examples: * @@ -243,7 +240,7 @@ export interface Page { * ``` * * Shortcut for main frame's - * [frame.waitForFunction(pageFunction[, arg, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#framewaitforfunctionpagefunction-arg-options). + * [frame.waitForFunction(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#framewaitforfunction). * @param pageFunction Function to be evaluated in browser context * @param arg Optional argument to pass to `pageFunction` * @param options @@ -295,7 +292,7 @@ export interface Page { * page: Page, frame: Frame }`. * * See - * [browserContext.exposeBinding(name, callback[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextexposebindingname-callback-options) + * [browserContext.exposeBinding(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextexposebinding) * for the context-wide version. * * > **NOTE** Functions installed via `page.exposeBinding` survive navigations. @@ -403,9 +400,8 @@ export interface Page { /** * Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Playwright can respond - * to the dialog via - * [dialog.accept([promptText])](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogacceptprompttext) or - * [dialog.dismiss()](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. + * to the dialog via [dialog.accept(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogaccept) or + * [dialog.dismiss(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. */ on(event: 'dialog', listener: (dialog: Dialog) => void): this; @@ -428,8 +424,8 @@ export interface Page { /** * Emitted when a file chooser is supposed to appear, such as after clicking the ``. Playwright can * respond to it via setting the input files using - * [fileChooser.setFiles(files[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfilesfiles-options) - * that can be uploaded after that. + * [fileChooser.setFiles(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfiles) that can + * be uploaded after that. * * ```js * page.on('filechooser', async (fileChooser) => { @@ -483,15 +479,15 @@ export interface Page { * ``` * * > **NOTE** Use - * [page.waitForLoadState([state, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstatestate-options) - * to wait until the page gets to a particular state (you should not need it in most cases). + * [page.waitForLoadState(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstate) to wait + * until the page gets to a particular state (you should not need it in most cases). */ on(event: 'popup', listener: (page: Page) => void): this; /** * Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see - * [page.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagerouteurl-handler) or - * [browserContext.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextrouteurl-handler). + * [page.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageroute) or + * [browserContext.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextroute). */ on(event: 'request', listener: (request: Request) => void): this; @@ -588,9 +584,8 @@ export interface Page { /** * Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Playwright can respond - * to the dialog via - * [dialog.accept([promptText])](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogacceptprompttext) or - * [dialog.dismiss()](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. + * to the dialog via [dialog.accept(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogaccept) or + * [dialog.dismiss(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. */ once(event: 'dialog', listener: (dialog: Dialog) => void): this; @@ -613,8 +608,8 @@ export interface Page { /** * Emitted when a file chooser is supposed to appear, such as after clicking the ``. Playwright can * respond to it via setting the input files using - * [fileChooser.setFiles(files[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfilesfiles-options) - * that can be uploaded after that. + * [fileChooser.setFiles(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfiles) that can + * be uploaded after that. * * ```js * page.on('filechooser', async (fileChooser) => { @@ -668,15 +663,15 @@ export interface Page { * ``` * * > **NOTE** Use - * [page.waitForLoadState([state, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstatestate-options) - * to wait until the page gets to a particular state (you should not need it in most cases). + * [page.waitForLoadState(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstate) to wait + * until the page gets to a particular state (you should not need it in most cases). */ once(event: 'popup', listener: (page: Page) => void): this; /** * Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see - * [page.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagerouteurl-handler) or - * [browserContext.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextrouteurl-handler). + * [page.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageroute) or + * [browserContext.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextroute). */ once(event: 'request', listener: (request: Request) => void): this; @@ -773,9 +768,8 @@ export interface Page { /** * Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Playwright can respond - * to the dialog via - * [dialog.accept([promptText])](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogacceptprompttext) or - * [dialog.dismiss()](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. + * to the dialog via [dialog.accept(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogaccept) or + * [dialog.dismiss(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. */ addListener(event: 'dialog', listener: (dialog: Dialog) => void): this; @@ -798,8 +792,8 @@ export interface Page { /** * Emitted when a file chooser is supposed to appear, such as after clicking the ``. Playwright can * respond to it via setting the input files using - * [fileChooser.setFiles(files[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfilesfiles-options) - * that can be uploaded after that. + * [fileChooser.setFiles(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfiles) that can + * be uploaded after that. * * ```js * page.on('filechooser', async (fileChooser) => { @@ -853,15 +847,15 @@ export interface Page { * ``` * * > **NOTE** Use - * [page.waitForLoadState([state, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstatestate-options) - * to wait until the page gets to a particular state (you should not need it in most cases). + * [page.waitForLoadState(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstate) to wait + * until the page gets to a particular state (you should not need it in most cases). */ addListener(event: 'popup', listener: (page: Page) => void): this; /** * Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see - * [page.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagerouteurl-handler) or - * [browserContext.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextrouteurl-handler). + * [page.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageroute) or + * [browserContext.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextroute). */ addListener(event: 'request', listener: (request: Request) => void): this; @@ -958,9 +952,8 @@ export interface Page { /** * Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Playwright can respond - * to the dialog via - * [dialog.accept([promptText])](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogacceptprompttext) or - * [dialog.dismiss()](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. + * to the dialog via [dialog.accept(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogaccept) or + * [dialog.dismiss(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. */ removeListener(event: 'dialog', listener: (dialog: Dialog) => void): this; @@ -983,8 +976,8 @@ export interface Page { /** * Emitted when a file chooser is supposed to appear, such as after clicking the ``. Playwright can * respond to it via setting the input files using - * [fileChooser.setFiles(files[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfilesfiles-options) - * that can be uploaded after that. + * [fileChooser.setFiles(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfiles) that can + * be uploaded after that. * * ```js * page.on('filechooser', async (fileChooser) => { @@ -1038,15 +1031,15 @@ export interface Page { * ``` * * > **NOTE** Use - * [page.waitForLoadState([state, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstatestate-options) - * to wait until the page gets to a particular state (you should not need it in most cases). + * [page.waitForLoadState(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstate) to wait + * until the page gets to a particular state (you should not need it in most cases). */ removeListener(event: 'popup', listener: (page: Page) => void): this; /** * Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see - * [page.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagerouteurl-handler) or - * [browserContext.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextrouteurl-handler). + * [page.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageroute) or + * [browserContext.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextroute). */ removeListener(event: 'request', listener: (request: Request) => void): this; @@ -1143,9 +1136,8 @@ export interface Page { /** * Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Playwright can respond - * to the dialog via - * [dialog.accept([promptText])](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogacceptprompttext) or - * [dialog.dismiss()](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. + * to the dialog via [dialog.accept(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogaccept) or + * [dialog.dismiss(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#dialogdismiss) methods. */ off(event: 'dialog', listener: (dialog: Dialog) => void): this; @@ -1168,8 +1160,8 @@ export interface Page { /** * Emitted when a file chooser is supposed to appear, such as after clicking the ``. Playwright can * respond to it via setting the input files using - * [fileChooser.setFiles(files[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfilesfiles-options) - * that can be uploaded after that. + * [fileChooser.setFiles(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#filechoosersetfiles) that can + * be uploaded after that. * * ```js * page.on('filechooser', async (fileChooser) => { @@ -1223,15 +1215,15 @@ export interface Page { * ``` * * > **NOTE** Use - * [page.waitForLoadState([state, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstatestate-options) - * to wait until the page gets to a particular state (you should not need it in most cases). + * [page.waitForLoadState(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitforloadstate) to wait + * until the page gets to a particular state (you should not need it in most cases). */ off(event: 'popup', listener: (page: Page) => void): this; /** * Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see - * [page.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagerouteurl-handler) or - * [browserContext.route(url, handler)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextrouteurl-handler). + * [page.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageroute) or + * [browserContext.route(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextroute). */ off(event: 'request', listener: (request: Request) => void): this; @@ -1292,10 +1284,9 @@ export interface Page { * ``` * * > **NOTE** The order of evaluation of multiple scripts installed via - * [browserContext.addInitScript(script[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextaddinitscriptscript-arg) - * and - * [page.addInitScript(script[, arg])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageaddinitscriptscript-arg) - * is not defined. + * [browserContext.addInitScript(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextaddinitscript) + * and [page.addInitScript(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pageaddinitscript) is not + * defined. * @param script Script to be evaluated in the page. * @param arg Optional argument to pass to `script` (only supported when passing a function). */ @@ -1317,7 +1308,7 @@ export interface Page { * fires or when the script content was injected into frame. * * Shortcut for main frame's - * [frame.addScriptTag(params)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameaddscripttagparams). + * [frame.addScriptTag(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameaddscripttag). * @param params */ addScriptTag(params: { @@ -1349,7 +1340,7 @@ export interface Page { * content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame. * * Shortcut for main frame's - * [frame.addStyleTag(params)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameaddstyletagparams). + * [frame.addStyleTag(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameaddstyletag). * @param params */ addStyleTag(params: { @@ -1391,8 +1382,7 @@ export interface Page { * When all steps combined have not finished during the specified `timeout`, this method rejects with a [TimeoutError]. * Passing zero timeout disables this. * - * Shortcut for main frame's - * [frame.check(selector[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#framecheckselector-options). + * Shortcut for main frame's [frame.check(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#framecheck). * @param selector A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. * @param options */ @@ -1412,9 +1402,8 @@ export interface Page { /** * Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by * using the - * [browserContext.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeouttimeout) - * or - * [page.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeouttimeout) + * [browserContext.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeout) + * or [page.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeout) * methods. */ timeout?: number; @@ -1433,8 +1422,7 @@ export interface Page { * When all steps combined have not finished during the specified `timeout`, this method rejects with a [TimeoutError]. * Passing zero timeout disables this. * - * Shortcut for main frame's - * [frame.click(selector[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameclickselector-options). + * Shortcut for main frame's [frame.click(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#frameclick). * @param selector A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. * @param options */ @@ -1485,9 +1473,8 @@ export interface Page { /** * Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by * using the - * [browserContext.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeouttimeout) - * or - * [page.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeouttimeout) + * [browserContext.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeout) + * or [page.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeout) * methods. */ timeout?: number; @@ -1545,7 +1532,7 @@ export interface Page { * > **NOTE** `page.dblclick()` dispatches two `click` events and a single `dblclick` event. * * Shortcut for main frame's - * [frame.dblclick(selector[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#framedblclickselector-options). + * [frame.dblclick(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#framedblclick). * @param selector A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. * @param options */ @@ -1591,9 +1578,8 @@ export interface Page { /** * Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by * using the - * [browserContext.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeouttimeout) - * or - * [page.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeouttimeout) + * [browserContext.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeout) + * or [page.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeout) * methods. */ timeout?: number; @@ -1637,9 +1623,8 @@ export interface Page { /** * Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by * using the - * [browserContext.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeouttimeout) - * or - * [page.setDefaultTimeout(timeout)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeouttimeout) + * [browserContext.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextsetdefaulttimeout) + * or [page.setDefaultTimeout(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagesetdefaulttimeout) * methods. */ timeout?: number; @@ -1700,7 +1685,7 @@ export interface Page { * If the `callback` returns a [Promise], it will be awaited. * * See - * [browserContext.exposeFunction(name, callback)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextexposefunctionname-callback) + * [browserContext.exposeFunction(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsercontextexposefunction) * for context-wide exposed function. * * > **NOTE** Functions installed via `page.exposeFunction` survive navigations. @@ -1769,10 +1754,9 @@ export interface Page { * clear the input field. * * To send fine-grained keyboard events, use - * [page.type(selector, text[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagetypeselector-text-options). + * [page.type(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagetype). * - * Shortcut for main frame's - * [frame.fill(selector, value[, options])](https://github.com/microsoft/playwright/blob/master/docs/api.md#framefillselector-value-options) + * Shortcut for main frame's [frame.fill(…)](https://github.com/microsoft/playwright/blob/master/docs/api.md#framefill) * @param selector A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See [working with selectors](https://github.com/microsoft/playwright/blob/master/docs/selectors.md#working-with-selectors) for more details. * @param value Value to fill for the ``, `